Rational Developer for System z

Return codes from the IRZPWSIO APIs

This topic describes the return codes from the IRZPWSIO APIs.

Table 1 describes the return codes:

Table 1. Return codes from the IRZPWSIO APIs
Value: IRZPWSH constant: Description:
000 @irz_success The API completed successfully.
100 @irz_omitted_parameter A required parameter was not specified to the API.
101 @irz_invalid_pointer The value of a pointer supplied to the API specified an invalid memory address.
102 @irz_invalid_struct_type The language structure type specified to the API was not one of IRZPWSH.@irz_soap_header_struct, IRZPWSH.@irz_soap_body_struct, or IRZPWSH.@irz_soap_fault_struct.
103 @irz_struct_not_found A language structure with the specified type was not found in the IMS™ message.
104 @irz_struct_name_mismatch A language structure of the specified type was found in the IMS message, but the specified name does not match.
105 @irz_invalid_struct_order An attempt to get or set a language structure out of order was detected. For example, it is an error to attempt to to get the SOAP body structure before getting the SOAP header structure, if a SOAP header is present in the IMS message.
106 @irz_invalid_struct_size The size of the language structure specified to the API was invalid (<=0) or exceeded the maximum (see IRZPWSH.@irz_message_max_data).
107 @irz_invalid_struct_name The specified language structure name was not a valid PL/I identifier.
108 @irz_struct_already_set The specified language structure type already exists in the IMS message.
109 @irz_invalid_segment_size The segment size specified in IMS Connect parameter XMPAMAXS is invalid (< = 5 or > = 32767).
997 @irz_icon_buf_exhausted The API was unable to get or set a language structure because it encountered the end of the IMS Connect input or output buffer. This error may only be raised when Compiled XML Conversion invokes the API.
998 @irz_cee_call_failure An error was encountered by the API when it invoked a Language Environment® callable service. Inspect the Language Environment condition token supplied in parameter @irz_cee_feedback_ptr for more information.
999 @irz_dli_call_failure An error was encountered by the API when it invoked the CEETDLI interface. Inspect the IOPCB supplied in parameter @irz_iopcb_ptr for more information.

Table 2 shows the return codes used by each API:

Table 2. Return codes used by each API
Value: IRZPWSH constant: IRZQGETS IRZQSETS IRZXGETS IRZXSETS
000 @irz_success X X X X
100 @irz_omitted_parameter X X X X
101 @irz_invalid_pointer X X X X
102 @irz_invalid_struct_type X X X X
103 @irz_struct_not_found X      
104 @irz_struct_name_mismatch X   X  
105 @irz_invalid_struct_order X X X X
106 @irz_invalid_struct_size   X   X
107 @irz_invalid_struct_name   X   X
108 @irz_struct_already_set   X   X
109 @irz_invalid_segment_size   X   X
997 @irz_icon_buf_exhausted     X X
998 @irz_cee_call_failure X X X  
999 @irz_dli_call_failure X X   X
1At runtime these error codes are cited by messages IRZ0500S and IRZ05001S, even though the APIs are internal to Compiled XML Conversion.


Feedback