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

MQe_QueueAdminMsg.h File Reference

MQeQueueAdminMsg object used to administration queues. More...


Functions

MQERETURN mqeQueueAdminMsg_new (MQeExceptBlock *pErrStruct, MQeQueueAdminMsgHndl *phMsgObj, MQECONST MQeStringHndl hQueueManagerName, MQECONST MQeStringHndl hQueueName)
 Constructs an MQeQueueAdminMsg object.

MQERETURN mqeQueueAdminMsg_addAlias (MQeQueueAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hAliasName)
 Adds a queue alias to the QueueAdminMsg.

MQERETURN mqeQueueAdminMsg_removeAlias (MQeQueueAdminMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hAliasName)
 Removes a queue alias from the QueueAdminMsg.

MQERETURN mqeQueueAdminMsg_setName (MQeQueueAdminMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hQueueMgrName, MQECONST MQeStringHndl hQueueName)
 Sets the name of the queue the actions is to be performed on.


Detailed Description

Following actions are available on local queues:

Local queues are local to the owning queue manager. A file descriptor must be set that details where and how the queue is stored. It is formed from two parts an adapter and a parameters to the adapter. The following adapters are provided:-

For example, if alias MsgLog is set to MQeDiskFieldsAdapter then to store messages at d:\ServerQM123\Queues, the file descriptor would be: MsgLog:d:\ServerQM123 \Queues Queues allow several characteristics to be set that are not used by the base local queue. These characteristics are made available to a user replaceable queue rules class that can make use of them. For instance Queue_MaxQSize can be set but is not checked by MQeQueue. It is the responsibility of the queues rules class to perform maximum queue size validation. This class acts as the base class for managing other types of queues. For instance MQeRemoteQueueAdminMsg derives from this class and handles management of remote queues.


Function Documentation

MQERETURN mqeQueueAdminMsg_new MQeExceptBlock   pErrStruct,
MQeQueueAdminMsgHndl *    phMsgObj,
MQECONST MQeStringHndl    hQueueManagerName,
MQECONST MQeStringHndl    hQueueName
 

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).
phMsgObj must not be NULL.
Returns :
New MQeQueueAdminMsg 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.

MQERETURN mqeQueueAdminMsg_addAlias MQeQueueAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hAliasName
 

Sets up an administration message to perform the MQE_ADMIN_ACTION_ADDALIAS action. A queue can have no aliases, one alias or several aliases. This method can be called more than once to allow multiple aliases to be added in one administration message.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsgObj  [out] AdminMsg object to use
hAliasName  [in] String containing the name of an alias
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
hMsgObj must not be NULL.
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeQueueAdminMsg_removeAlias MQeQueueAdminMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hAliasName
 

Sets up an administration message to perform the MQE_ADMIN_ACTION_REMOVEALIAS action This action removes the named alias from the queue. This method may be called more than once to allow multiple aliases to be remove using one administration message.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMsg  [in] AdminMsg object to use.
hAliasName  [in] String containing the alias name
Precondition:
pErrStruct must point to a pre-allocated MQeExceptBlock structure.
hMsg must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeQueueAdminMsg_setName MQeQueueAdminMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hQueueMgrName,
MQECONST MQeStringHndl    hQueueName
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMsg  [in] AdminMsg object to use.
hQueueMgrName  [in] String containing the name of the queue manager that owns the queue
hQueueName  [in] String containing the name of the queue
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
hMsgObj must not be NULL.
Return values:
MQERETURN_OK  Completed Successfully


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