Flex Functions (FLEX) > Alphabetical List of Functions > Flex and Flex AMF > flex_amf_define_envelope_header_set

flex_amf_define_envelope_header_set

Example: Setup and invoke flex_amf_call Flex AMF Alphabetical Listing

Defines a set of FLex AMF envelope headers.

int flex_amf_define_envelope_header_set( "ID=<header set name>", HEADER,  "<XML string describing the header>", [HEADER, "<header 2>",..., HEADER, "<header n>",] LAST ); 

This function returns LR_PASS (0) on success or LR_FAIL (1) on failure. Note that LR_PASS and LR_FAIL generally indicate whether the function call completed without an exception, and not that the test step succeeded.

All input string arguments (char type) except the step name can be parameterized using standard parameterization.

Arguments

Name Comments
ID The ID of the envelope header set. The ID is used by subsequent flex_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 flex_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 flex_amf_call invocations.