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

MQe_AdminQueueAdminMsg.h File Reference

C API header file for MQeAdminQueueAdminMsg helper functions and constants. More...


Functions

MQERETURN mqeAdminQueueAdminMsg_new (MQeExceptBlock *pErrStruct, MQeAdminQueueAdminMsgHndl *phMsgObj, MQECONST MQeStringHndl hQueueMgr, MQECONST MQeStringHndl hQueue)
 This function constructs an MQeAdminQueueAdminMsgHndl dedicated to MQSeries Everyplace administration (in its default form).


Detailed Description

This object is used to manage queues of type MQeAdminQueue. The MQeAdminQueue is used for transparent local and remote administration of managed resources

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 that some extra default fields are introduced. Any calls (except mqeMsg_free()) that are applicable to an MQeMsg can also be applied to the returned object.


Function Documentation

MQERETURN mqeAdminQueueAdminMsg_new MQeExceptBlock   pErrStruct,
MQeAdminQueueAdminMsgHndl *    phMsgObj,
MQECONST MQeStringHndl    hQueueMgr,
MQECONST MQeStringHndl    hQueue
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMsgObj  [out] Pointer to handle for output
hQueueMgr  [in] Name of queue Manager
hQueue  [in] Name of Queue
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phMsgObj must not be NULL.
Returns :
New Handle to an MQeAdminQueueAdminMsg placed 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:18 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference