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

MQe_MsgEvent.h File Reference

The MQSeries Everyplace MessageEvent class C API header file. More...


Functions

MQERETURN mqeMessageEvent_free (MQeMessageEventHndl hMessageEvent, MQeExceptBlock *pErrStruct)
 This function frees the MQeMessageEvent pointed by hMessageEvent.

MQERETURN mqeMessageEvent_getMessageFields (MQeMessageEventHndl hMessageEvent, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phMsgFields)
 This function returns an MQeFields containing selected fields from which the message that caused the event to be generated. The unique id of the message is always returned to gether with the MQeSeries Message id, MQeSeries Correlation id, message priority values if they are present in the message.

MQERETURN mqeMessageEvent_getQueueManagerName (MQeMessageEventHndl hMessageEvent, MQeExceptBlock *pErrStruct, MQeStringHndl *phQueueManagerName)
 This function returns the name of the queue manager that owns the queue that generated event hMessageEvent.

MQERETURN mqeMessageEvent_getQueueName (MQeMessageEventHndl hMessageEvent, MQeExceptBlock *pErrStruct, MQeStringHndl *phQueueName)
 This function returns the name of the queue that generated event hMessageEvent.


Detailed Description

It describes MQeMessageEvent C API prototypes.


Function Documentation

MQERETURN mqeMessageEvent_free MQeMessageEventHndl    hMessageEvent,
MQeExceptBlock   pErrStruct
 

Parameters:
hMessageEvent  [in] Handle for the MQeMessageEvent 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).
Returns :
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEvent_getMessageFields MQeMessageEventHndl    hMessageEvent,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phMsgFields
 

Parameters:
hMessageEvent  [in] Handle for the MQeMessageEvent to be freed.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsgFields  [out] Pointer to result handle.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEvent_getQueueManagerName MQeMessageEventHndl    hMessageEvent,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phQueueManagerName
 

Parameters:
hMessageEvent  [in] Handle for the MQeMessageEvent to be freed.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phQueueManagerName  [out] Pointer to handle for output buffer
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
phQueueManagerName.
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEvent_getQueueName MQeMessageEventHndl    hMessageEvent,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phQueueName
 

Parameters:
hMessageEvent  [in] Handle for the MQeMessageEvent to be freed.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phQueueName  [out] Pointer to handle for output buffer
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
phQueueName.
Return values:
MQERETURN_OK  Operation successful


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