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

MQe_QueueManagerConfigure.h File Reference

The MQSeries Everyplace QMgrConfig class C API header file for Java bindings. More...


Functions

MQERETURN mqeQueueManagerConfigure_new (MQeExceptBlock *pErrStruct, MQeQueueManagerConfigureHndl *phQMgrConfig, MQECONST MQeFieldsHndl hStartUpParams, MQeStringHndl hQStore)
 This function constructs/activates a mqeQueueManagerConfigure.

MQERETURN mqeQueueManagerConfigure_activate (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hStartUpParams, MQeStringHndl hQStore)
 This function activates a mqeQueueManagerConfigure to make it ready to configure a queue manager.

MQERETURN mqeQueueManagerConfigure_close (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function closes (*hQMgrConfig).

MQERETURN mqeQueueManagerConfigure_free (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function frees (*hQMgrConfig).

MQERETURN mqeQueueManagerConfigure_defineDefaultAdminQueue (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQeStringHndl hDescription)
 This function defines a standard administration queue in the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_defineDefaultAdminReplyQueue (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQeStringHndl hDescription)
 This function defines a standard administration reply queue in the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_defineDefaultDeadLetterQueue (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQeStringHndl hDescription)
 This function defines a standard administration reply queue in the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_defineDefaultSystemQueue (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQeStringHndl hDescription)
 This function defines a standard SYSTEM.DEFAULT.LOCAL.QUEUE local queue in the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_defineQueueManager (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function defines a queue manager in the registry.

MQERETURN mqeQueueManagerConfigure_deleteAdminQueueDefinition (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function deletes the definition of the standard administration queue from the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_deleteAdminReplyQueueDefinition (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function deletes the definition of the standard administration reply queue from the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_deleteDeadLetterQueueDefinition (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function deletes the definition of the standard dead letter queue from the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_deleteQueueManagerDefinition (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function deletes the definition of the standard dead letter queue from the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_deleteStandardQMDefinitions (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function deletes the definitions of the standard default queues and the queue manager itself from the registry.

MQERETURN mqeQueueManagerConfigure_deleteSystemQueueDefinition (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct)
 This function deletes the definition of the standard SYSTEM.DEFAULT.LOCAL.QUEUE local queue from the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_queueManagerExists (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQEBOOL *pExists)
 This function checks if the queue manager definition exists in the registry for the queue manager.

MQERETURN mqeQueueManagerConfigure_setChannelTimeout (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQEINT64 timeout)
 This function sets the channel time-out value for the queue manager.

MQERETURN mqeQueueManagerConfigure_setChnlAttributeRuleName (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQeStringHndl hRuleName)
 This function sets the channel attribute rule class for the queue manager.

MQERETURN mqeQueueManagerConfigure_setDescription (MQeQueueManagerConfigureHndl hQMgrConfig, MQeExceptBlock *pErrStruct, MQeStringHndl hRuleName)
 This function sets the description for the queue manager.


Detailed Description

It describes MQSeries Everyplace C API prototypes.


Function Documentation

MQERETURN mqeQueueManagerConfigure_new MQeExceptBlock   pErrStruct,
MQeQueueManagerConfigureHndl *    phQMgrConfig,
MQECONST MQeFieldsHndl    hStartUpParams,
MQeStringHndl    hQStore
 

  • If hStartUpParams is not NULL, (*hStartUpParams) is used to activate the created queue manager by calling mqeQueueManagerConfigure_activate(hStartUpParams, hQStore) internally. Otherwise, it just creates a default mqeQueueManagerConfigure. The mqeQueueManagerConfigure_activate() function must be called later to initialize and start the queue manager.
  • If hStartUpParams is not NULL but hQStore is NULL, this function can only be used to delete a queue manager.
Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phQMgrConfig  [out] Pointer to output handle.
hStartUpParams  [in] a Fields containing startup parameters.
hQStore  [in] location where the standard default queues are stored.
Precondition:
phQMgrConfig must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*phQMgrConfig).
Return values:
MQERETURN_OK  Operation successful
Warning:
Users are expected to use mqeQueueManagerConfigure_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 mqeQueueManagerConfigure_activate MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQECONST MQeFieldsHndl    hStartUpParams,
MQeStringHndl    hQStore
 

  • If hQStore is NULL, this function can only be used to delete a queue manager.
Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure object to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hStartUpParams  [in] a Fields containing startup parameters.
hQStore  [in] location where the standard default queues are stored.
Precondition:
hQMgrConfig must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*hQMgrConfig).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeQueueManagerConfigure_close MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

An attempt to use the closed object after it has been closed results in an error being raised. The object must be closed before the queue manager itself can be activated.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure 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  Operation successful

MQERETURN mqeQueueManagerConfigure_free MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure 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  Operation successful

MQERETURN mqeQueueManagerConfigure_defineDefaultAdminQueue MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hDescription
 

An error is raised if the queue already exists.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_defineDefaultAdminReplyQueue MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hDescription
 

An error is raised if the queue already exists.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_defineDefaultDeadLetterQueue MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hDescription
 

An error is raised if the queue already exists.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_defineDefaultSystemQueue MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hDescription
 

An error is raised if the queue already exists.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_defineQueueManager MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

This is required before the queue manager itself can be activated. An error is raised if the queue manager definition already exists.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_deleteAdminQueueDefinition MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

No error is generated if the definition does not already exist.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_deleteAdminReplyQueueDefinition MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

No error is generated if the definition does not already exist. The queue itself is not removed.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_deleteDeadLetterQueueDefinition MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

No error is generated if the definition does not already exist. The queue itself is not removed.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_deleteQueueManagerDefinition MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

No error is generated if the definition does not already exist. The queue itself is not removed.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_deleteStandardQMDefinitions MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

No error is generated if the definitions do not already exist. It is equivalent to applying mqeQMgr_deleteDeadLetterQueueDefinition(), mqeQMgr_deleteSystemQueueDefinition(), mqeQMgr_deleteAdminQueueDefinition(), mqeQMgr_deleteAdminReplyQueueDefinition(), and mqeQMgr_deleteQueueManagerDefinition().

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_deleteSystemQueueDefinition MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct
 

No error is generated if the definition does not already exist. The queue itself is not removed.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
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  Operation successful

MQERETURN mqeQueueManagerConfigure_queueManagerExists MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pExists
 

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pExists  [out] Pointer to result variable.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
pExists must point to an existing variable.
Returns :
(*pExists).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeQueueManagerConfigure_setChannelTimeout MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQEINT64    timeout
 

This function must be called before mqeQueueManagerConfigure_defineQueueManager(), otherwise it is ignored.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
timeout  [in] the time-out value.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
pTimeout must point to an existing variable.
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeQueueManagerConfigure_setChnlAttributeRuleName MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hRuleName
 

This function must be called before mqeQueueManagerConfigure_defineQueueManager(), otherwise it is ignored.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pRuleName  [in] the rule name.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
pRuleName must point to an existing MQeStringHndl.
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeQueueManagerConfigure_setDescription MQeQueueManagerConfigureHndl    hQMgrConfig,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hRuleName
 

This function must be called before mqeQueueManagerConfigure_defineQueueManager(), otherwise it is ignored.

Parameters:
hQMgrConfig  [in] the mqeQueueManagerConfigure to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pDesc  [in] the description.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
pDesc must point to an existing MQeString.
Return values:
MQERETURN_OK  Operation successful


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