Rational Developer for System z

IRZXSETS

The IRZXSETS API creates a SOAP structure from the information in a language structure passed as input. Also, when specified, IRZXSETS 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, IRZXSETS 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 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).
Limitations:

Parameters:

Table 1. Parameters for IRZXSETS
Parameter: Type: Usage: Description:
@irz_async_msg_header_ptr POINTER BYVALUE Input A pointer-by-value to the instance of @irz_async_msg_header that is to be sent as the first segment of the IMS message.
@irz_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).
@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_icon_buf_used SIGNED FIXED BIN(31) BYADDR Output An integer-by-reference into which IRZXSETS 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.
@irz_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 IRZPWSH can be used: @irz_soap_body_struct.
@irz_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 @irz_struct_type.
@irz_struct_ptr POINTER BYVALUE Input A pointer-by-value to a structure corresponding to the structure specified in parameters @irz_struct_type and @irz_struct_name.
@irz_struct_size SIGNED FIXED BIN(31) BYVALUE Input An integer-by-value specifying the size in bytes of the structure pointed to by parameter @irz_struct_ptr.
@irz_commit_structs BIT(1) BYVALUE Input A bit-by-value indicating whether IRZXSETS should copy the current language structure and all previously supplied language structures into the IMS Connect output buffer.
@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 IRZXSETS invokes Language Environment Callable Services.
Note: If the return code from IRZXSETS 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 IRZXSETS should display trace information (see Trace output for WSDL2PLI).

Return codes:

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

Table 2. Return codes for IRZXSETS
Type: Name: Value:
SIGNED FIXED BIN(31) @irz_success 000
@irz_omitted_parameter 100
@irz_invalid_pointer 101
@irz_invalid_struct_type 102
@irz_invalid_struct_order 105
@irz_invalid_struct_size 106
@irz_invalid_struct_name 107
@irz_struct_already_set 108
@irz_invalid_segment_size 109
@irz_icon_buf_exhausted 997
@irz_cee_call_failure 998


Feedback