DFSXSETS

The DFSXSETS API creates a SOAP structure from the information in a language structure passed as input. Also, when specified, DFSXSETS copies the current SOAP structure and all previously supplied SOAP structures into the IMS Connect output buffer.

Because the IMS Message Queue is not available to XML Conversion in IMS Connect, DFSXSETS inserts language structures into the IMS Connect output buffer. The format of the IMS Connect output buffer is an array of IMS message segments (LLZZDATA).

The structures and variables referred to in this topic are defined in DFSPWSH (see Include file DFSPWSH).

Note: This API is for use by PL/I XML converters running in IMS Connect. It is not to be used by a message processing program (MPP).

Limitations:

DFSXSETS does not support the storing of a SOAP Header structure.

Parameters:

Table 1. Parameters for DFSXSETS
Parameter	Type	Usage	Description
@dfs_async_msg_header_ptr	POINTER BYVALUE	Input	A pointer-by-value to the instance of @dfs_async_msg_header that is to be sent as the first segment of the IMS message.
@dfs_icon_buf_ptr	POINTER BYVALUE	Input	A pointer-by-value to the IMS Connect output message buffer. The expected format of the buffer is an array of IMS message segments (LLZZDATA).
@dfs_icon_buf_len	SIGNED FIXED BIN(31) BYVALUE	Input	An integer-by-value specifying the length in bytes of the buffer pointed to by @dfs_icon_buf_ptr.
@dfs_icon_buf_used	SIGNED FIXED BIN(31) BYADDR	Output	An integer-by-reference into which DFSXSETS writes the number of bytes that are required to format the language structure as a multisegment IMS message in the IMS Connect output buffer. The value of this parameter is always greater than the actual size of the language structure by at least 4 bytes.
@dfs_struct_type	SIGNED FIXED BIN(31) BYVALUE	Input	An integer-by-value specifying the type of language structure to set in the IMS Connect output buffer. The following constants defined in include file DFSPWSH can be used: @dfs_soap_body_struct.
@dfs_struct_name	WCHAR(128) VARYING BYADDR	Input	A string-by-reference containing the name of the language structure that corresponds to the value of the parameter @dfs_struct_type.
@dfs_struct_ptr	POINTER BYVALUE	Input	A pointer-by-value to a structure corresponding to the structure specified in parameters @dfs_struct_type and @dfs_struct_name.
@dfs_struct_size	SIGNED FIXED BIN(31) BYVALUE	Input	An integer-by-value specifying the size in bytes of the structure pointed to by parameter @dfs_struct_ptr.
@dfs_commit_structs	BIT(1) BYVALUE	Input	A bit-by-value indicating whether DFSXSETS should copy the current language structure and all previously supplied language structures into the IMS Connect output buffer.
@dfs_cee_feedback_ptr	POINTER BYVALUE	Input	A pointer-by-value to an instance of @dfs_cee_feedback defining a Language Environment® Condition Token. This instance is updated each time DFSXSETS invokes Language Environment Callable Services. Note: If the return code from DFSXSETS is 998 then use the publication Language Environment Run-Time Messages (SA22-7566-10) to inspect the contents of the condition token and determine the cause of the error.
@dfs_debug	BIT(1) OPTIONAL	Input	An optional bit indicating whether DFSXSETS should display trace information (see Trace output for WSDL-to-PL/I segmentation APIs).

Return codes:

The return codes for DFSXSETS are constants defined in the DFSPWSH include file:

Table 2. Return codes for DFSXSETS
Type:	Name:	Value:
SIGNED FIXED BIN(31)	@dfs_success	000
	@dfs_omitted_parameter	100
	@dfs_invalid_pointer	101
	@dfs_invalid_struct_type	102
	@dfs_invalid_struct_order	105
	@dfs_invalid_struct_size	106
	@dfs_invalid_struct_name	107
	@dfs_struct_already_set	108
	@dfs_invalid_segment_size	109
	@dfs_icon_buf_exhausted	997
	@dfs_cee_call_failure	998