Get - MQ_GET_EXIT

 

MQ_GET_EXIT provides a get exit function to perform before and after MQGET call processing. There are two function identifiers:

1. Use MQXF_GET with exit reasons MQXR_BEFORE and MQXR_AFTER to register before and after MQGET call exit functions.

2. Use MQXF_DATA_CONV_ON_GET with exit reason MQXR_BEFORE to register a before MQGET data conversion exit function.

The interface to this function is:

MQ_GET_EXIT (&ExitParms, &ExitContext, &Hconn, &Hobj, &pMsgDesc,
             &pGetMsgOpts, &BufferLength, &pBuffer, &pDataLength,
             &CompCode, &Reason)

where the parameters are:

ExitParms (MQAXP) - input/output

Exit parameter structure.

ExitContext (MQAXC) - input/output

Exit context structure.

Hconn (MQHCONN) - input

Connection handle.

Hobj (MQHOBJ) - input/output

Object handle.

pMsgDesc (PMQMD) - input/output

Pointer to message descriptor.

pGetMsgOpts (PMQPMO) - input/output

Pointer to get message options.

BufferLength (MQLONG) - input/output

Message buffer length.

pBuffer (PMQBYTE) - input/output

Pointer to message buffer.

pDataLength (PMQLONG) - input/output

Pointer to data length field.

CompCode (MQLONG) - input/output

Completion code, valid values for which are:

MQCC_OK

Successful completion.

MQCC_WARNING

Partial completion.

MQCC_FAILED

Call failed

Reason (MQLONG) - input/output

Reason code qualifying the completion code.

If the completion code is MQCC_OK, the only valid value is:

MQRC_NONE

(0, x'000') No reason to report.

If the completion code is MQCC_FAILED or MQCC_WARNING, the exit function can set the reason code field to any valid MQRC_* value.

• C language invocation
  

 

Parent topic:

The API exit functions

fg14870_