mq-get-entire-return-status

Library: MQSeries access (OMMQI) legacy
Include: ommqi.xin

Declaration

define external function mq-get-entire-return-status
          modifiable    mq-response-record    responses

Argument definitions

responses: is a shelf of mq-response-records in which a record will be inserted for each error that just occurred.

Purpose

Use mq-get-entire-return-status to retrieve the IBM MQSeries error codes when the "MQI0001" external exception is received.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "ommqi.xin"

Usage Notes

When an OmniMark program receives the "MQI0001" external exception, that indicates that multiple IBM MQSeries error occurred during the ommqi function which was just called. mq-get-entire-return-status can be called to retrieve a shelf of response records returned by the IBM MQSeries client.

The responses shelf is cleared, and then one mq-response-record opaque is placed in the shelf for each error that occurred. The mq-get-response-record function can be used to get the CompCode and Response value from each mq-response-record.

The error codes are cleared upon the next ommqi call.

See OMMQI Error Handling for an example of how this function is used.

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.