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

MQe_MQBridgeAdminMsg.h File Reference


Functions

MQERETURN mqeMQBridgeAdminMsg_new (MQeExceptBlock *pErrStruct, MQeMQBridgeAdminMsgHndl *phMsgObj, MQeStringHndl hBridgeName, MQEBOOL affectChildren)
 Create MQeBridgeAdminMsg that includes the name of bridge and children flag.

MQERETURN mqeMQBridgeAdminMsg_free (MQeMQBridgeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct)
 Frees the MQeMQBridgeAdminMsgHndl pointed by phMsgObj.

MQERETURN mqeMQBridgeAdminMsg_create (MQeMQBridgeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl hfields)
MQERETURN mqeMQBridgeAdminMsg_getBridgeName (MQeMQBridgeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phBridgeName)
MQERETURN mqeMQBridgeAdminMsg_delete (MQeMQBridgeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl hParams, MQEBOOL affectChildren)
MQERETURN mqeMQBridgeAdminMsg_putBridgeName (MQeMQBridgeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hBridgeName)

Detailed Description


Function Documentation

MQERETURN mqeMQBridgeAdminMsg_new MQeExceptBlock   pErrStruct,
MQeMQBridgeAdminMsgHndl *    phMsgObj,
MQeStringHndl    hBridgeName,
MQEBOOL    affectChildren
 

Parameters:
hBridgeName  [in] Name of the MQSeries-bridge to be administered
affectChildren  [in] Flag indicating whether or not this message affects the children of the listener
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

MQERETURN mqeMQBridgeAdminMsg_free MQeMQBridgeAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsgObj  [in] MQeMQBridgeAdminMsgHndl 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

MQERETURN mqeMQBridgeAdminMsg_create MQeMQBridgeAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl    hfields
 

Causes this administration message to be a "create" message. When the target MQSeries Everyplace system processes this message it creates an MQSeries queue manager entity

Parameters:
hMsgObj  [in] MQeMQBridgeAdminMsgHndl to be freed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFields  [in] Any extra parameters or NULL
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 mqeMQBridgeAdminMsg_getBridgeName MQeMQBridgeAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phBridgeName
 

Gets the MQSeries-Bridge name from the administered object. Can be called against an MQeMQBridgeAdminMsg or one of its descendants

Parameters:
hMsgObj  [in] MQeMQBridgeAdminMsgHndl to be freed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phBridgeName  [out] Name of the MQSeries-Bridge
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 mqeMQBridgeAdminMsg_delete MQeMQBridgeAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl    hParams,
MQEBOOL    affectChildren
 

Cause this administration message to be a "delete" message When the target MQSeries Everyplace system processes this message it finds the specified MQSeries_bridge and deletes it.

Parameters:
hMsgObj  [in] MQeMQBridgeAdminMsgHndl to be deleted
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hParams  [in] Extra parameters
affectChildren  [in] Flag indicating whether or not this administration message affects the children of the listener
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 mqeMQBridgeAdminMsg_putBridgeName MQeMQBridgeAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hBridgeName
 

Used by the source of the administration message to add the MQSeries queue manager name to the administration message

Parameters:
hMsgObj  [in] MQeMQBridgeAdminMsgHndl to be deleted
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hBridgeName  [in] Name of the MQSeries-Bridge. If null or "" passed then it is not set
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