Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQe_QueueManagerAdminMsg.h File Reference

C API header file for MQSeries Everyplace QueueManager administration message helper functions and constants. More...


Functions

MQERETURN mqeQueueManagerAdminMsg_new (MQeExceptBlock *pErrStruct, MQeQueueManagerAdminMsgHndl *phMsgObj, MQECONST MQeStringHndl hQueueMgr)
 Constructs an MQeQueueManagerAdminMsg.


Detailed Description

The following actions are applicable on queue managers:

Note:
Create and Delete actions are not supported on queue managers as a queue manager has to be in place and have an administration queue initialized on it before administration can take place, and only one queue manager per process is supported.

Function Documentation

MQERETURN mqeQueueManagerAdminMsg_new MQeExceptBlock   pErrStruct,
MQeQueueManagerAdminMsgHndl *    phMsgObj,
MQECONST MQeStringHndl    hQueueMgr
 

Users are expected to apply mqeAdminMsg_*() API calls to the returned object. However, the returned object is no different from an object returned by mqeMsg_new() except some extra default fields are introduced. Any calls (except mqeMsg_free()) applicable to an MQeMsg can therefore be applied to the returned object as well (provided you known what you are doing).

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsgObj  [out] Pointer to handle for output.
hQueueMgr  [int] string containing a queue manager name, may be NULL.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phMsgObj must not be NULL.
Returns :
MQeQueueManagerAdminMsg object place in (*phMsgObj)
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeAdminMsg_free() to free the object returned by this call when it is no longer needed. This enables reuse of system resources and can help to avoid system problems caused by shortage of resources.


Generated Thu Aug 11 23:41:22 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference