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

MQe_StoreAndForwardQueueAdminMsg.h File Reference

MQeStoreAndForwardQueueadminMsg object. More...


Functions

MQERETURN mqeStoreAndForwardQueueAdminMsg_new (MQeExceptBlock *pErrStruct, MQeStoreAndFwdQueueAdminMsgHndl *phMsgObj, CONST MQeStringHndl hQueueMgr, CONST MQeStringHndl hQueue)
 Constructs an MQeStoreAndForwardAdminQueueMsg.

MQERETURN mqeStoreAndForwardQueueAdminMsg_addQueueManager (MQeStoreAndFwdQueueAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hQMgr)
 Adds a queue manager.

MQERETURN mqeStoreAndForwardQueueAdminMsg_removeQueueManager (MQeStoreAndFwdQueueAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hQMgr)
 Removes a queue manager.

MQERETURN mqeStoreAndForwardQueueAdminMsg_free (MQeStoreAndFwdQueueAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct)
 Frees the MQeStoreAndForwardQueueAdminMsg pointed by hMsgObj.


Detailed Description

Store and Forward Queues are used in intermediate nodes to hold messages that are just passing through, i.e. that are not destined for any queues on this system.


Function Documentation

MQERETURN mqeStoreAndForwardQueueAdminMsg_new MQeExceptBlock   pErrStruct,
MQeStoreAndFwdQueueAdminMsgHndl *    phMsgObj,
CONST MQeStringHndl    hQueueMgr,
CONST 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 a queue manager name, may be NULL.
hQueue  [in] Name of the 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 :
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.

MQERETURN mqeStoreAndForwardQueueAdminMsg_addQueueManager MQeStoreAndFwdQueueAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hQMgr
 

Sets up and administration message to perform the MQE_ADMIN_ACTION_ADDQMGR A queue may have one or more target queue managers. This method may be called more than once to allow multiple targets to be added in one administration message

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsgObj  [out] Pointer to handle for output.
hQMgr  [in] Queue manager to add
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeStoreAndForwardQueueAdminMsg_removeQueueManager MQeStoreAndFwdQueueAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hQMgr
 

Sets up a administration message to perform the MQE_ADMIN_ACTION_REMOVEQMGR This method may be called more than once to allow multiple targets to be removed in one admin message.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsgObj  [out] Pointer to handle for output.
hQMgr  [in] Queue manager to add
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeStoreAndForwardQueueAdminMsg_free MQeStoreAndFwdQueueAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsgObj  [in] the MQeMsg to be freed.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully


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