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

MQe_MQBridgesAdminMsg.h File Reference


Functions

MQERETURN mqeMQBridgesAdminMsg_new (MQeExceptBlock *pErrStruct, MQeMQBridgesAdminMsgHndl *phMsgObj, MQEBOOL affectChildren)
 Creates a new MQeMQBridgesAdminMsg.

MQERETURN mqeMQBridgesAdminMsg_free (MQeMQBridgesAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct)
 Frees MQeMQBridgesAdminMsg.

MQERETURN mqeMQBridgesAdminMsg_start (MQeMQBridgesAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBOOL affectChildren, MQeFieldsHndl hFields)
 Tells the administered object to start.

MQERETURN mqeMQBridgesAdminMsg_stop (MQeMQBridgesAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl hFields)
 Tells the administered object to stop.


Detailed Description


Function Documentation

MQERETURN mqeMQBridgesAdminMsg_new MQeExceptBlock   pErrStruct,
MQeMQBridgesAdminMsgHndl *    phMsgObj,
MQEBOOL    affectChildren
 

Parameters:
hMQMsgObj  [out] Pointer to Handle to output
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
affectChildren  [in] Flag to determine if the children are affected. True means it is allowed to affect the children.
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 mqeMQBridgesAdminMsg_free MQeMQBridgesAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct
 

Parameters:
hMQMsgObj  [out] Handle to AdminMsg
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 mqeMQBridgesAdminMsg_start MQeMQBridgesAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQEBOOL    affectChildren,
MQeFieldsHndl    hFields
 

Parameters:
hMQMsgObj  [out] Handle to AdminMsg
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
affectChildren  [in] Flag to indicate if the children should be affected
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 mqeMQBridgesAdminMsg_stop MQeMQBridgesAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl    hFields
 

All child objects are told to stop as well

Parameters:
hMQMsgObj  [out] Handle to AdminMsg
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hFields  [in] Set of fields that contain the MQSeries-bridge name and other parameters
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