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

MQe_RemoteQueueAdminMsg.h File Reference

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


Functions

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


Detailed Description


Function Documentation

MQERETURN mqeRemoteQueueAdminMsg_new MQeExceptBlock   pErrStruct,
MQeRemoteQueueAdminMsgHndl *    phMsgObj,
MQECONST MQeStringHndl    hQueueMgr,
MQECONST MQeStringHndl    hQueue
 

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  [in] string containing the name of a queue manager, may be NULL
hQueue  [in] string containing the name of a queue, may be NULL
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Precondition:
phMsgObj must not be NULL.
Returns :
in (*phMsgObj)
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeAdminQueueAdminMsg_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:23 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference