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

flex_amf_define_header_set

Example: Setup and invoke flex_amf_call Flex AMF Alphabetical Listing

Defines a set of Flex AMF headers.

int flex_amf_define_header_set( "ID=<Flex 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 );

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 Flex AMF header set. This ID is used by subsequent flex_amf_call steps to specify this set of Flex AMF headers.
HEADER A marker that specifies the beginning of the data of a new header.
Name Flex 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 flex_amf_define_header_set function defines a set containing one or more headers. This set that can then be used by one or more subsequent flex_amf_call invocations.