Action Message Format Vuser Functions (AMF) > Alphabetical List of Functions > amf_define_envelope_header_set

amf_define_envelope_header_set

Example: Using AMF functions. Action Message Format Vuser Functions (AMF)

Defines a set of envelope headers.

int amf_define_envelope_header_set( "ID=<header set name>", HEADER, "<XML string describing the header>", [HEADER, "<header 2>",..., HEADER, "<header n>",] LAST ); 
ID The ID of the envelope header set. The ID is used by subsequent amf_call invocations to specify this set of headers.
HEADER A marker that specifies a new header.
XML string describing the header The data associated with the header is an XML string.
LAST A marker that indicates the end of the field list.

The amf_define_envelope_header_set function defines a set containing one or more envelope headers. The set can be used by one or more subsequent amf_call invocations.

Return Values

This function returns LR_PASS (0) on success, and LR_FAIL (1) on failure. Note that in many cases, this return value indicates the technical success of the function, and not the result. For example, a function that registers a string to be found in a subsequent step returns LR_PASS to indicate that the registration was successful. This does not indicate that the string was found in the server response.

Parameterization

All arguments can be parameterized using standard parameterization.