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

MQe_HomeServerQueueAdminMsg.h File Reference

Used to manage Home Server Queues. More...


Functions

MQERETURN mqeHomeServerQueueAdminMsg_new (MQeExceptBlock *pErrStruct, MQeHomeServerQueueAdminMsgHndl *phMsgObj, MQECONST MQeStringHndl hQueueMgr, MQECONST MQeStringHndl hQueue)
 Constructs an MQeHomeServerQueueAdminMsg object.


Detailed Description

The Home Server queue is used to retrieve (using a background thread) pending messages from it's home-queue on it's home-server.


Function Documentation

MQERETURN mqeHomeServerQueueAdminMsg_new MQeExceptBlock   pErrStruct,
MQeHomeServerQueueAdminMsgHndl *    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 for some extra default fields that are introduced. Any calls (except mqeMsg_free()) that are applicable to an MQeMsg can be applied to the returned object.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMsgObj  [out] Pointer to handle for output
pQueueMgr  [in] String containing the name of a queue manager, may be NULL
pQueue  [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).
phMsgObj must not be NULL.
Returns :
A new MQeHomeServerQueueAdminMsg place 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:19 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference