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

MQe_Administrator.h File Reference

The MQe Administrator API. More...


Functions

MQERETURN mqeAdministrator_new (MQeExceptBlock *pExceptBlock, MQeAdministratorHndl *phAdmin, MQeQueueManagerHndl hQueueManager)
 Creates a new MQeAdministrator.

MQERETURN mqeAdministrator_free (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock)
 Destroys an MQeAdministrator previously created with mqeAdministrator_new.

MQERETURN mqeAdministrator_QueueManager_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeQueueManagerHndl *phQueueManager, MQeStringHndl hQueueManagerName, MQeQueueManagerParms *pCreateParms, MQeRegistryParms *pRegistryParms)
 Creates an MQeQueueManager on disk and loads it into memory.

MQERETURN mqeAdministrator_QueueManager_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock)
 Removes an MQeQueueManager from disk and frees it.

MQERETURN mqeAdministrator_QueueManager_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeQueueManagerParms *pQMParms)
 Obtains information about the operational parameters of an MQeQueueManager.

MQERETURN mqeAdministrator_QueueManager_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeQueueManagerParms *pQMParms)
 Updates the operational parameters of an MQeQueueManager.

MQERETURN mqeAdministrator_LocalQueue_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeLocalQParms *pParams)
 Creates a local queue in memory and on disk and adds it to the "current" queue manager.

MQERETURN mqeAdministrator_LocalQueue_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName)
 Deletes a local queue from memory and removes it from disk and the "current" queue manager.

MQERETURN mqeAdministrator_LocalQueue_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeLocalQParms *pParams)
 Obtains information about the operational parameters of a local queue.

MQERETURN mqeAdministrator_LocalQueue_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeLocalQParms *pParams)
 Updates the operational parameters of a local queue.

MQERETURN mqeAdministrator_LocalQueue_listAliasNames (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeVectorHndl *phAliasVector)
 Creates a vector containing all the aliases for a local queue.

MQERETURN mqeAdministrator_LocalQueue_addAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Adds an alias to a local queue.

MQERETURN mqeAdministrator_LocalQueue_removeAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Removes an alias from a local queue.

MQERETURN mqeAdministrator_SyncRemoteQueue_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeRemoteSyncQParms *pParams)
 Creates a synchronous remote queue in memory and on disk and adds it to the "current" queue manager.

MQERETURN mqeAdministrator_SyncRemoteQueue_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName)
 Deletes a synchronous remote queue from memory and removes it from disk and the "current" queue manager.

MQERETURN mqeAdministrator_SyncRemoteQueue_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeRemoteSyncQParms *pParams)
 Obtains information about the operational parameters of a synchronous remote queue.

MQERETURN mqeAdministrator_SyncRemoteQueue_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeRemoteSyncQParms *pParams)
 Updates the operational parameters of a synchronous remote queue.

MQERETURN mqeAdministrator_SyncRemoteQueue_listAliasNames (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeVectorHndl *phAliasVector)
 Creates a vector containing all the aliases for a synchronous remote queue.

MQERETURN mqeAdministrator_SyncRemoteQueue_addAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Adds an alias to a synchronous remote queue.

MQERETURN mqeAdministrator_SyncRemoteQueue_removeAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Removes an alias from a synchronous remote queue.

MQERETURN mqeAdministrator_AsyncRemoteQueue_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeRemoteAsyncQParms *pParams)
 Creates an asynchronous remote queue in memory and on disk and adds it to the "current" queue manager.

MQERETURN mqeAdministrator_AsyncRemoteQueue_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName)
 Deletes an asynchronous remote queue from memory and removes it from disk and the "current" queue manager.

MQERETURN mqeAdministrator_AsyncRemoteQueue_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeRemoteAsyncQParms *pParams)
 Obtains information about the operational parameters of an asynchronous remote queue.

MQERETURN mqeAdministrator_AsyncRemoteQueue_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeRemoteAsyncQParms *pParams)
 Updates the operational parameters of an asynchronous remote queue.

MQERETURN mqeAdministrator_AsyncRemoteQueue_listAliasNames (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeVectorHndl *phAliasVector)
 Creates a vector containing all the aliases for an asynchronous remote queue.

MQERETURN mqeAdministrator_AsyncRemoteQueue_addAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Adds an alias to an asynchronous remote queue.

MQERETURN mqeAdministrator_AsyncRemoteQueue_removeAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Removes an alias from an asynchronous remote queue.

MQERETURN mqeAdministrator_AdminQueue_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeAdminQParms *pParams)
 Creates an admin queue in memory and on disk and adds it to the "current" queue manager.

MQERETURN mqeAdministrator_AdminQueue_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName)
 Deletes an admin queue from memory and removes it from disk and the "current" queue manager.

MQERETURN mqeAdministrator_AdminQueue_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeAdminQParms *pParams)
 Obtains information about the operational parameters of an admin queue.

MQERETURN mqeAdministrator_AdminQueue_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeAdminQParms *pParams)
 Updates the operational parameters of an admin queue.

MQERETURN mqeAdministrator_AdminQueue_listAliasNames (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeVectorHndl *phAliasVector)
 Creates a vector containing all the aliases for an admin queue.

MQERETURN mqeAdministrator_AdminQueue_addAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Adds an alias to an admin queue.

MQERETURN mqeAdministrator_AdminQueue_removeAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Removes an alias from an admin queue.

MQERETURN mqeAdministrator_HomeServerQueue_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQMgrName, MQeHomeServerQParms *pParams)
 Creates a homeServer queue in memory and on disk and adds it to the "current" queue manager.

MQERETURN mqeAdministrator_HomeServerQueue_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName)
 Deletes a homeServer queue from memory and removes it from disk and the "current" queue manager.

MQERETURN mqeAdministrator_HomeServerQueue_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeHomeServerQParms *pParams)
 Obtains information about the operational parameters of a homeServer queue.

MQERETURN mqeAdministrator_HomeServerQueue_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeHomeServerQParms *pParams)
 Updates the operational parameters of a homeServer queue.

MQERETURN mqeAdministrator_HomeServerQueue_listAliasNames (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeVectorHndl *phAliasVector)
 Creates a vector containing all the aliases for a homeServer queue..

MQERETURN mqeAdministrator_HomeServerQueue_addAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Adds an alias to a homeServer queue.

MQERETURN mqeAdministrator_HomeServerQueue_removeAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hQueueName, MQeStringHndl hQueueQueueManagerName, MQeStringHndl hAliasName)
 Removes an alias from a homeServer queue.

MQERETURN mqeAdministrator_Connection_create (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hConnectionName, MQeConnectionDefinitionParms *pParams)
 Creates a connection in memory and on disk and adds it to the "current" queue manager.

MQERETURN mqeAdministrator_Connection_delete (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hConnectionName)
 Deletes a connection from memory and removes it from disk and the "current" queue manager.

MQERETURN mqeAdministrator_Connection_inquire (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hConnectionName, MQeConnectionDefinitionParms *pParams)
 Obtains information about the operational parameters of a connection.

MQERETURN mqeAdministrator_Connection_update (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hConnectionName, MQeConnectionDefinitionParms *pParams)
 Updates the operational parameters of a connection.

MQERETURN mqeAdministrator_QueueManager_addAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hAliasName, MQeStringHndl hTargetQueueManagerName)
 Creates a QueueManager alias.

MQERETURN mqeAdministrator_QueueManager_removeAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hAliasName)
 Deletes a QueueManager alias.

MQERETURN mqeAdministrator_QueueManager_resolveAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hAliasName, MQeStringHndl *phTargetQueueManagerName)
 Gets the target QueueManager name for a given alias name.

MQERETURN mqeAdministrator_QueueManager_listAliasNames (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeVectorHndl *phAliasList)
 Creates a vector containing all the QueueManager aliases.

MQERETURN mqeAdministrator_QueueManager_isAlias (MQeAdministratorHndl hAdmin, MQeExceptBlock *pExceptBlock, MQeStringHndl hAliasName, MQEBOOL *pIsAlias)
 Checks whether a supplied MQeString is an alias for a Queue Manager.


Detailed Description

This class allows the user to administer (create, delete etc.) an MQe QueueManager and associated components (queues, etc.)


Function Documentation

MQERETURN mqeAdministrator_new MQeExceptBlock   pExceptBlock,
MQeAdministratorHndl *    phAdmin,
MQeQueueManagerHndl    hQueueManager
 

Parameters:
pExceptBlock  [in/out] Exception block to be filled in case of error
phAdmin  [out] Pointer to a location at which to place the handle to the new Administrator
hQueueManager  [in] Optional handle to the Queue Manager which will be administered. If NULL, then the only valid operations on the resulting Administrator are mqeAdministrator_QueueManager_create and mqeAdministrator_free.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_free MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_QueueManager_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeQueueManagerHndl *    phQueueManager,
MQeStringHndl    hQueueManagerName,
MQeQueueManagerParms   pCreateParms,
MQeRegistryParms   pRegistryParms
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
phQueueManager  [out] pointer to hold the handle to the created queue manager
hQueueManagerName  [in] handle to queue manager name
pCreateParms  [in] Pointer to a structure containing creation parameters
pRegistryParms  [in] Pointer to a structure containing registry configuration parameters
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_QueueManager_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
All queues and connection definitions must previously have been deleted.
Warning:
You should not attempt to call mqeQueueManager_free after this call as the queue manager will already have been freed from memory
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_QueueManager_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeQueueManagerParms   pQMParms
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
pQMParms  [in/out] Pointer to a structure which contains information regarding what information is required on input and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_QueueManager_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeQueueManagerParms   pQMParms
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
pQMParms  [in] Pointer to a structure which contains details of the information to be updated on input and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_LocalQueue_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeLocalQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in] Pointer to an MQeLocalQParms structure containing parameters which control queue creation.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_LocalQueue_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be deleted
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_LocalQueue_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeLocalQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in/out] A pointer to a structure which contains details of the information required on input (eg Name) and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_LocalQueue_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeLocalQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have its be updated
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in] A pointer to a structure which contains information regarding what information is to be updated and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_LocalQueue_listAliasNames MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeVectorHndl *    phAliasVector
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have its aliases listed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
phAliasVector  [out] Pointer to an MQeVectorHndl to return the MQeString handles for all the aliases for this queue.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_LocalQueue_addAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias added
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be added.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
MQERETURN_NOTHING_TO_DO, MQEREASON_DUPLICATE  queue already has an alias of this name

MQERETURN mqeAdministrator_LocalQueue_removeAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias removed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be removed.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_SyncRemoteQueue_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeRemoteSyncQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in] A pointer to an MQeremoteSyncQParms structure containing parameters which control queue creation.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_SyncRemoteQueue_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be deleted
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_SyncRemoteQueue_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeRemoteSyncQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue which is the subject of the inquire
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in/out] A pointer to an MQeRemoteSyncQParms structure which contains details of the information required on input (eg Name) and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_SyncRemoteQueue_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeRemoteSyncQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be updated
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in] A pointer to a structure which contains information regarding what information is to be updated and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_SyncRemoteQueue_listAliasNames MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeVectorHndl *    phAliasVector
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have its aliases listed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
phAliasVector  [out] Pointer to an MQeVectorHndl to return the MQeString handles for all the aliases for this queue.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_SyncRemoteQueue_addAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias added
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be added.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
MQERETURN_NOTHING_TO_DO, MQEREASON_DUPLICATE  queue already has an alias of this name

MQERETURN mqeAdministrator_SyncRemoteQueue_removeAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias removed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be removed.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AsyncRemoteQueue_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeRemoteAsyncQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in] A pointer to an MQeRemoteAsyncQParms structure containing parameters which control queue creation.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AsyncRemoteQueue_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be deleted
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AsyncRemoteQueue_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeRemoteAsyncQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in/out] A pointer to a structure which contains details of the information required on input (eg Name) and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AsyncRemoteQueue_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeRemoteAsyncQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be updated
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in] A pointer to a structure which contains information regarding what information is to be updated and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AsyncRemoteQueue_listAliasNames MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeVectorHndl *    phAliasVector
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have its aliases listed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
phAliasVector  [out] Pointer to an MQeVectorHndl to return the MQeString handles for all the aliases for this queue.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AsyncRemoteQueue_addAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias added
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be added.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
MQERETURN_NOTHING_TO_DO, MQEREASON_DUPLICATE  queue already has an alias of this name

MQERETURN mqeAdministrator_AsyncRemoteQueue_removeAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias removed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be removed.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AdminQueue_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeAdminQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in] A pointer to an MQeAdminQParms structure containing parameters which control queue creation.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AdminQueue_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be deleted
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AdminQueue_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeAdminQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue which is the subject of the inquire
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in/out] A pointer to a structure which contains details of the information required on input (eg Name) and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AdminQueue_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeAdminQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue being updated
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in] A pointer to a structure which contains details of the information to be updated and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AdminQueue_listAliasNames MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeVectorHndl *    phAliasVector
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have its aliases listed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
phAliasVector  [out] Pointer to an MQeVectorHndl to return the MQeString handles for all the aliases for this queue.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_AdminQueue_addAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias added
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be added.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
MQERETURN_NOTHING_TO_DO, MQEREASON_DUPLICATE  queue already has an alias of this name

MQERETURN mqeAdministrator_AdminQueue_removeAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias removed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be removed.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_HomeServerQueue_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQMgrName,
MQeHomeServerQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Queue name
hQueueQMgrName  [in] Queue queue manager name
pParams  [in] MQeHomeServerQParms containing parameters which control queue creation.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_HomeServerQueue_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be deleted
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_HomeServerQueue_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeHomeServerQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue which is the subject of the inquire
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in/out] A pointer to a structure which contains details of the information required on input (eg Name) and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_HomeServerQueue_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeHomeServerQParms   pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to be updated
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
pParams  [in] A pointer to a structure which contains details of the information to be updated and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_HomeServerQueue_listAliasNames MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeVectorHndl *    phAliasVector
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have its aliases listed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
phAliasVector  [out] Pointer to an MQeVectorHndl to return the MQeString handles for all the aliases for this queue.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_HomeServerQueue_addAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias added
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be added.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
MQERETURN_NOTHING_TO_DO, MQEREASON_DUPLICATE  queue already has an alias of this name

MQERETURN mqeAdministrator_HomeServerQueue_removeAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hQueueName,
MQeStringHndl    hQueueQueueManagerName,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hQueueName  [in] Name of the Queue to have an alias removed
hQueueQueueManagerName  [in] Name of the QueueManager with which this queue is associated.
hAliasName  [in] Alias Name to be removed.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_Connection_create MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hConnectionName,
MQeConnectionDefinitionParms *    pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hConnectionName  [in] Name of the connection to be created.
pParams  [in] Structure containing parameters which control connection creation.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
QueueManager must have been previously opened via mqeAdministrator_QueueManager_create or by passing the queue manager handle to mqeAdministrator_new.
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
Note:
If a viaQM connection is being created, only the hViaQMName connection definition parameter should be set. In this case, the hConnectionName parameter is the MQeStringHndl name for the ultimate target queue manager while the hViaQMName component of the MQeConnectionDefinitionParms structure represents the viaQM name.

MQERETURN mqeAdministrator_Connection_delete MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hConnectionName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hConnectionName  [in] Name of the Connection to be deleted
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_Connection_inquire MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hConnectionName,
MQeConnectionDefinitionParms *    pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hConnectionName  [in] Name of the Connection to be inquired upon
pParams  [in/out] A structure which contains information regarding what information is required on input (eg Name) and contains the actual information on output. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are required.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally

MQERETURN mqeAdministrator_Connection_update MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hConnectionName,
MQeConnectionDefinitionParms *    pParams
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hConnectionName  [in] Name of the connection to be updated
pParams  [in] A pointer to a structure which contains details of the information to be updated and the actual information itself. The structure is comprised of an entry for each possible piece of information and a flag which specifies which items are supplied.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_ALLOCATION_FAIL  memory allocation failed internally
Note:
If the hViaQMName connection definition parameter is set, no other connection definition parameters should be set.

MQERETURN mqeAdministrator_QueueManager_addAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hAliasName,
MQeStringHndl    hTargetQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hTargetQueueManagerName  [in] Name of the target queue manager to be aliased
hAliasName  [in] Alias name which can be used to refer to the target queue mananger.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Target Queue Manager must have been previously created or opened using mqeAdministrator_QueueManager_create or mqeAdministrator_QueueManager_open.

MQERETURN mqeAdministrator_QueueManager_removeAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hAliasName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hAliasName  [in] Alias name to be removed.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Target Queue Manager must have been previously created or opened using mqeAdministrator_QueueManager_create or mqeAdministrator_QueueManager_open.

MQERETURN mqeAdministrator_QueueManager_resolveAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hAliasName,
MQeStringHndl *    phTargetQueueManagerName
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hAliasName  [in] Alias name for which we want to find the target
phTargetQueueManagerName  [out] A pointer to the name of the target queue manager
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Target Queue Manager must have been previously created or opened using mqeAdministrator_QueueManager_create or mqeAdministrator_QueueManager_open.

MQERETURN mqeAdministrator_QueueManager_listAliasNames MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeVectorHndl *    phAliasList
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
phAliasList  [out] Pointer to an MQeVectorHndl to return the MQeString handles for all the aliases for this queue manager.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Target Queue Manager must have been previously created or opened using mqeAdministrator_QueueManager_create or mqeAdministrator_QueueManager_open.

MQERETURN mqeAdministrator_QueueManager_isAlias MQeAdministratorHndl    hAdmin,
MQeExceptBlock   pExceptBlock,
MQeStringHndl    hAliasName,
MQEBOOL *    pIsAlias
 

Parameters:
hAdmin  [in] Handle to the MQeAdministrator
pExceptBlock  [in/out] Exception block to be filled in case of error
hAliasName  [in] Candidate alias name
pIsAlias  [out] Pointer to a boolean indicating whether hAliasName is an alias or not.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Target Queue Manager must have been previously created or opened using mqeAdministrator_QueueManager_create or mqeAdministrator_QueueManager_open.


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