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

amf_define_header_set

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

Defines a set of AMF headers.

int amf_define_header_set( "ID=<AMF header set name>", HEADER, "Name=<header name>", "MustUnderstand=<boolean value>", "Data=<XML string describing the header data>", [ HEADER, <header section 2>, ... HEADER, <header section n>,] LAST );
ID The ID of the AMF header set. This ID is used by subsequent amf_call steps to specify this set of AMF headers.
HEADER A marker that specifies the beginning of the data of a new header.
Name AMF header name.
MustUnderstand Indicates whether processing the call continues if the server cannot interpret the header. If MustUnderstand is true, this header is mandatory and processing is aborted if it is not understood.
Data The data associated with the header is an XML string. For more details, see AMF Arguments.
LAST A marker that indicates the end of the field list.

The amf_define_header_setfunction defines a set containing one or more headers. This set that can then 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.