ReturnedLength (MQLONG)
This is an output field
that the queue manager sets to the length in bytes of the message data returned
by the MQGET call in the Buffer
parameter.
If the queue manager does not support this capability, ReturnedLength
is
set to the value MQRL_UNDEFINED.
When messages are converted between encodings or character sets,
the message data can sometimes change size. On return from the MQGET call:
- If
ReturnedLength
is not MQRL_UNDEFINED, the number of bytes of message data returned is given byReturnedLength
. - If
ReturnedLength
has the value MQRL_UNDEFINED, the number of bytes of message data returned is usually given by the smaller ofBufferLength
andDataLength
, but can be less than this if the MQGET call completes with reason code MQRC_TRUNCATED_MSG_ACCEPTED. If this happens, the insignificant bytes in theBuffer
parameter are set to nulls.
The following special value is defined:
- MQRL_UNDEFINED
- Length of returned data not defined.
On z/OS®,
the value returned for the ReturnedLength
field
is always MQRL_UNDEFINED.
The initial value of this field is MQRL_UNDEFINED. This field
is ignored if Version
is less than
MQGMO_VERSION_3.