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

MQe_MQBridges.h File Reference


Functions

MQERETURN mqeMQBridges_new (MQeExceptBlock *pErrStruct, MQeMQBridgesHndl *phMQBridges)
 Creates a new MQeMQBridges object Needs to be called to create the MQeMQBridges object.

MQERETURN mqeMQBridges_activate (MQeMQBridgesHndl hMQBridges, MQeExceptBlock *pErrStruct, MQeFieldsHndl hConfig)
 Call be the server just after the new method used to pass configuration information to the MQeMQBridges object so that it can load any specific MQSeries-bridges specified in the configuration.

MQERETURN mqeMQBridges_close (MQeMQBridgesHndl hMQBridges, MQeExceptBlock *pErrStruct)
 Closes the MQeMQBridges object Closes down the MQeMQBridges object as cleanly as possible.

MQERETURN mqeMQBridges_free (MQeMQBridgesHndl hMQBridges, MQeExceptBlock *pErrStruct)
 Release the resource used by this object.


Detailed Description

The MQeMQBridges acts as a "loader" for all the MQSeries bridges. The MQSeries Everyplace server can be set (via an ini file) to create instances of the MQeMQBridges Object.

Server code calls the mqeMQBridges_activate just after it calls the mqeMQBridges_new method to create the MQeMQBridges object.

To shutdown the MQeMQBridges the mqeMQBridges_close() method needs to be called


Function Documentation

MQERETURN mqeMQBridges_new MQeExceptBlock   pErrStruct,
MQeMQBridgesHndl *    phMQBridges
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMQBridges  [out] Pointer to handle for output.
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 mqeMQBridges_activate MQeMQBridgesHndl    hMQBridges,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl    hConfig
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMQBridges  [out] Handle to the MQeMQBridges
hConfig  [in] MQeFields Handle contains the configuration.
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 mqeMQBridges_close MQeMQBridgesHndl    hMQBridges,
MQeExceptBlock   pErrStruct
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMQBridges  [out] Handle to the MQeMQBridges
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 mqeMQBridges_free MQeMQBridgesHndl    hMQBridges,
MQeExceptBlock   pErrStruct
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMQBridges  [out] Handle to the MQeMQBridges
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:19 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference