Sun Java System Message Queue 4.3 Developer's Guide for C Clients

MQGetStatusString

The MQGetStatusString function returns an MQString describing the specified status.


MQString MQGetStatusString(const MQStatus status);

Parameters

status

The status returned by any Message Queue function that returns an MQStatus.

Having found that a Message Queue function has not returned successfully, you can determine the reason why by passing the return status. This function will return an MQString describing the error associated with the specified status.

To obtain the error code for the specified status, use the MQGetStatusCode() function. To get an error trace associated with the error, use the MQGetErrorTrace() function.

You must call the MQFreeString function to free the MQString returned by the MQGetStatusString function when you are done.