DFSXGETS

The DFSXGETS API retrieves a SOAP structure from the IMS Connect input buffer and returns the information to the caller in a high-level language structure.

Because the IMS Message Queue is not available to XML Conversion in IMS Connect, DFSXGETS retrieves language structures from the IMS Connect input buffer. The expected format of the IMS Connect input buffer is an array of IMS message segments (LLZZDATA).

The structures and variables referred to in this topic are defined in the include file 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).

Restrictions:

DFSXGETS supports the retrieval of SOAP Body and SOAP Fault structures only. The SOAP Header structure is not supported.

Parameters:

Table 1. Parameters for DFSXGETS
Parameter	Type	Usage	Description
@dfs_async_msg_header_ptr	POINTER BYADDR	Output	A pointer-by-reference to the instance of @dfs_async_msg_header that was received in the IMS Connect input buffer.
@dfs_icon_buf_ptr	POINTER BYVALUE	Input	A pointer-by-value to the IMS Connect input message buffer. The expected format of the buffer is an array of 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_struct_type	SIGNED FIXED BIN(31) BYVALUE	Input	An integer-by-value specifying the type of structure to retrieve from the IMS Connect input buffer. The following constants defined in the include file DFSPWSH can be used: @dfs_soap_body_struct.
@dfs_struct_name	WCHAR(100) VARYING BYADDR	Input	A string-by-reference containing the name of the language structure to retrieve from the IMS Connect input buffer. The value of this parameter must correspond to the value of the parameter @dfs_struct_type.
@dfs_struct_ptr	POINTER BYADDR	Output	A pointer-by-reference into which DFSXGETS writes the address of a buffer containing the bytes of the structure requested in parameters @dfs_struct_type and @dfs_struct_name. Important: This buffer must be freed by the XML Converter prior to returning to IMS Connect because the Language Environment® enclave in which the XML Converters execute is persistent.
@dfs_struct_size	SIGNED FIXED BIN(31) BYADDR	Output	An integer-by-reference into which DFSXGETS writes the size in bytes of the structure returned in the parameter @dfs_struct_ptr.
@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 DFSXGETS invokes Language Environment Callable Services. Note: If the return code from DFSXGETS 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 DFSXGETS should display trace information (see Trace output for WSDL-to-PL/I segmentation APIs).

Return codes:

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

Table 2. Return codes for DFSXGETS
Type:	Name:	Value:
SIGNED FIXED BIN(31)	@dfs_success	000
	@dfs_omitted_parameter	100
	@dfs_invalid_pointer	101
	@dfs_invalid_struct_type	102
	@dfs_struct_not_found	103
	@dfs_struct_name_mismatch	104
	@dfs_invalid_struct_order	105
	@dfs_icon_buf_exhausted	997
	@dfs_cee_call_failure	998