Rational Developer for System z

IRZXGETS

The IRZXGETS 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, IRZXGETS retrieves language structures from the IMS Connect input buffer. The expected format of the IMS Connect input buffer is is an array of IMS message segments (LLZZDATA).

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

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:

Parameters:

Table 1. Parameters for IRZXGETS
Parameter: Type: Usage: Description:
@irz_async_msg_header_ptr POINTER BYADDR Output A pointer-by-reference to the instance of @irz_async_msg_header that was received in the IMS Connect input buffer.
@irz_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.
@irz_icon_buf_len SIGNED FIXED BIN(31) BYVALUE Input An integer-by-value specifying the length in bytes of the buffer pointed to by @irz_icon_buf_ptr.
@irz_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 IRZPWSH can be used: @irz_soap_body_struct.
@irz_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 @irz_struct_type.
@irz_struct_ptr POINTER BYADDR Output A pointer-by-reference into which IRZXGETS writes the address of a buffer containing the bytes of the structure requested in parameters @irz_struct_type and @irz_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.
@irz_struct_size SIGNED FIXED BIN(31) BYADDR Output An integer-by-reference into which IRZXGETS writes the size in bytes of the structure returned in the parameter @irz_struct_ptr.
@irz_cee_feedback_ptr POINTER BYVALUE Input A pointer-by-value to an instance of @irz_cee_feedback defining a Language Environment Condition Token. This instance is updated each time IRZXGETS invokes Language Environment Callable Services.
Note: If the return code from IRZXGETS 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.
@irz_debug BIT(1) OPTIONAL Input An optional bit indicating whether IRZXGETS should display trace information (see Trace output for WSDL2PLI).

Return codes:

The return codes for IRZXGETS are constants defined in the IRZPWSH include file:

Table 2. Return codes for IRZXGETS
Type: Name: Value:
SIGNED FIXED BIN(31) @irz_success 000
@irz_omitted_parameter 100
@irz_invalid_pointer 101
@irz_invalid_struct_type 102
@irz_struct_not_found 103
@irz_struct_name_mismatch 104
@irz_invalid_struct_order 105
@irz_icon_buf_exhausted 997
@irz_cee_call_failure 998


Terms of use | Feedback

This information center is powered by Eclipse technology. (http://www.eclipse.org)