gtpc2m4vC/C++ Language Support User's Guide

MQCLOSE-Close a Queue

This function closes a queue.

Format

#include  <cmqc.h>
void      MQCLOSE(MQHCONN Hconn,
                  PMQHOBJ pHobj,
                  MQLONG  Options,
                  PMQLONG pCompCode,
                  PMQLONG pReason);

Hconn
The connection handle, which represents the connection to the TPF MQSeries queue manager. The value of Hconn was returned by a previous MQCONN call.

pHobj
A pointer to the location to store the queue handle, which represents the queue. The value of Hobj was returned by a previous MQOPEN call.

Options
The options that control the action of MQCLOSE. TPF MQSeries queue manager ignores this parameter.

pCompCode
A pointer to the location to store the completion code, which is one of the following:

MQCC_OK
Successfully completed.

MQCC_FAILED
The call failed.

pReason
A pointer to the location to store the reason code that qualifies the completion code.

If the completion code is MQCC_OK, the reason code is MQRC_NONE, which indicates a normal return.

If the completion code is MQCC_FAILED, see Error Return for the corresponding reason codes.

See MQSeries Application Programming Reference and MQSeries Message Queue Interface Technical Reference for more information about MQSeries data types and parameters.

Normal Return

MQCC_OK
Completion code completed successfully.

MQRC_NONE
Reason code completed successfully.

Error Return

If the completion code is MQCC_FAILED, the function failed with one of the following reason codes:

MQRC_HCONN_ERROR
The connection handle is not valid.

MQRC_HOBJ_ERROR
The object handle is not valid.

MQRC_Q_MGR_NOT_ACTIVE
The TPF MQSeries queue manager is not started.

MQRC_Q_MGR_NOT_AVAILABLE
The TPF MQSeries queue manager is not loaded.

Programming Considerations

If the Hconn parameter is not for the local TPF MQSeries queue manager, this MQCLOSE function call will be sent by TPF MQSeries client support to the remote queue manager for processing. The options supported by the remote queue manager can differ from the options specified for the local TPF MQSeries queue manager.

Examples

The following example closes a queue.

#include <cmqc.h>
 
PMQHOBJ pHobj;
MQLONG  CompCode;                        /* completion code        */
MQLONG  Reason;                          /* reason code            */
MQHCONN Hcon;                            /* Connection Handle      */
MQLONG  C_options = 0;
 
/* Hcon and Hobj from previous MQCONN MQOPEN                       */
MQCLOSE(Hcon, pHobj, C_options, &CompCode, &Reason);
 
if(Reason != MQRC_NONE)
   printf("MQCLOSE ended with reason code %d.\n",Reason);

Related Information