Return codes from the DFSPWSIO APIs
This topic describes the return codes from the DFSPWSIO APIs.
The following table describes the return codes:
| Value | DFSPWSH constant | Description |
|---|---|---|
| 000 | @dfs_success | The API completed successfully. |
| 100 | @dfs_omitted_parameter | A required parameter was not specified to the API. |
| 101 | @dfs_invalid_pointer | The value of a pointer supplied to the API specified an invalid memory address. |
| 102 | @dfs_invalid_struct_type | The language structure type specified to the API was not one of DFSPWSH.@dfs_soap_header_struct, DFSPWSH.@dfs_soap_body_struct, or DFSPWSH.@dfs_soap_fault_struct. |
| 103 | @dfs_struct_not_found | A language structure with the specified type was not found in the IMS message. |
| 104 | @dfs_struct_name_mismatch | A language structure of the specified type was found in the IMS message, but the specified name does not match. |
| 105 | @dfs_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 | @dfs_invalid_struct_size | The size of the language structure specified to the API was invalid (<=0) or exceeded the maximum (see DFSPWSH.@dfs_message_max_data). |
| 107 | @dfs_invalid_struct_name | The specified language structure name was not a valid PL/I identifier. |
| 108 | @dfs_struct_already_set | The specified language structure type already exists in the IMS message. |
| 109 | @dfs_invalid_segment_size | The segment size specified in IMS Connect parameter XMPAMAXS is
invalid (< = 5 or > = 32767). |
| 995 | @dfs_fetch_failure | The API was unable to fetch a required load module from the available libraries. An instance of Enterprise PL/I runtime message IBM0590S was generated prior to receiving this return code. |
| 997 | @dfs_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 | @dfs_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 @dfs_cee_feedback_ptr for more information. |
| 999 | @dfs_dli_call_failure | An error was encountered by the API when it invoked the CEETDLI interface. Inspect the IOPCB supplied in parameter @dfs_iopcb_ptr for more information. |
The following table shows the return codes used by each API:
| Value | DFSPWSH constant | DFSQGETS | DFSQSETS | DFSXGETS | DFSXSETS |
|---|---|---|---|---|---|
| 000 | @dfs_success | X | X | X | X |
| 100 | @dfs_omitted_parameter | X | X | X | X |
| 101 | @dfs_invalid_pointer | X | X | X | X |
| 102 | @dfs_invalid_struct_type | X | X | X | X |
| 103 | @dfs_struct_not_found | X | |||
| 104 | @dfs_struct_name_mismatch | X | X | ||
| 105 | @dfs_invalid_struct_order | X | X | X | X |
| 106 | @dfs_invalid_struct_size | X | X | ||
| 107 | @dfs_invalid_struct_name | X | X | ||
| 108 | @dfs_struct_already_set | X | X | ||
| 109 | @dfs_invalid_segment_size | X | X | ||
| 995 | @dfs_fetch_failure | X | X | X | X |
| 997 | @dfs_icon_buf_exhausted | X | X | ||
| 998 | @dfs_cee_call_failure | X | X | X | |
| 999 | @dfs_dli_call_failure | X | X | X |