MmsGetCustomHeader Function

Action

Retrieves the specified custom MMS header. To retrieve the values of known MMS headers, use the MmsGetHeader and MmsGetHeaderString functions instead.

Include file

MmsLib.bdh

Syntax

MmsGetCustomHeader( in  hMms      : number,
                    in  sHeader   : string,
                    out sValue    : string,
                    in  nMaxValue : number optional,
                    out nCopied   : number optional ): boolean;

Return value

  • true if successful

  • false otherwise

Parameter Description
hMms Handle for the MMS, returned by a call to MmsCreateMms.
sHeader Specifies the custom MMS header.
sValue Specifies the value of the custom MMS header.
nMaxValue Optional: Maximum length of the string that can be returned. This value must be less than or equal to the size of the string variable sValue.
nCopied Optional: Variable receiving the number of actually copied bytes.

Example

dcltrans  
  transaction TWap  
  var
    sData   : string(0x10000);
    nData   : number;
    hMms    : number;
    nStatus : number;
    sGroup  : string;
  begin
    nData := WapGetContent(sData);
    MmsCreateMms(hMms);
    MmsParseMms(hMms, sData, nData, true);
    MmsGetCustomHeader(hMms, "GROUP", sGroup);
    MmsDeleteMms(hMms);
    print(sGroup);
  end TWap;