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

MQe_Msg.h File Reference

MQeMsg object. More...


Functions

MQERETURN mqeMsg_new (MQeExceptBlock *pErrStruct, MQeMsgHndl *phMsg)
 This function constructs an MQeMsg.

MQERETURN mqeMsg_free (MQeMsgHndl hMsg, MQeExceptBlock *pErrStruct)
 Frees the MQeMsg pointed by hMsg.

MQERETURN mqeMsg_unwrapMsg (MQeMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQeMsgHndl *phMsg, MQECONST MQeAttributeHndl hAttribute)
 This function unwraps an embedded MQeMsg, decode using (*hAttribute) (if hAttribute not NULL) and returns the new message.

MQERETURN mqeMsg_getMsgUIDFields (MQeMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phOutUID)
 This function gets a Fields that contains all the elements of the unique id.

MQERETURN mqeMsg_getOriginQMgr (MQeMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQeStringHndl *phOutQMgrName)
 This function gets the MsgObject's origination queue manager name - may be null.

MQERETURN mqeMsg_getTimeStamp (MQeMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQEINT64 *pOutTimeStamp)
 This function gets the MsgObject's creation time.

MQERETURN mqeMsg_resetMsgUIDFields (MQeMsgHndl hMsg, MQeExceptBlock *pErrStruct)
 This function resets the UID fields of a message.


Detailed Description


Function Documentation

MQERETURN mqeMsg_new MQeExceptBlock   pErrStruct,
MQeMsgHndl *    phMsg
 

Users are expected to apply mqeMsg_*() API calls to the returned object. However, the returned object is no different from an object returned by mqeFields_new() except some extra default fields are introduced. Any calls (except mqeFields_free()) applicable to an MQeFields can therefore be applied to the returned object as well.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsg  [out] Pointer to the output handle.
Precondition:
phMsg must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
output in (*phMsg).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_TYPE  Wrong type of entry/object
MQERETURN_J_NOT_FOUND  Entry/object not found
Warning:
Users are expected to use mqeMsg_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 mqeMsg_free MQeMsgHndl    hMsg,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsg  [in] the MQeMsg 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 mqeMsg_unwrapMsg MQeMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQeMsgHndl *    phMsg,
MQECONST MQeAttributeHndl    hAttribute
 

Parameters:
hMsg  [in] the message that contains the message already wrapped.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phOutMsg  [out] Pointer to pointer to output (unwrapped) message.
hAttribute  [in] an attribute to be used.
Precondition:
hMsg must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOutMsg must point to an existing pointer.
Returns :
Output in (*phOutMsg).
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeMsg_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 mqeMsg_getMsgUIDFields MQeMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phOutUID
 

Parameters:
hMsg  [in] the message to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phOutUID  [out] Pointer to pointer to output Fields.
Precondition:
hMsg must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOutUID must point to an existing handle.
Returns :
output in (*phOutUID).
Return values:
MQERETURN_OK  Completed Successfully
MQERETURN_J_NOT_ALLOWED  Action not allowed
Warning:
Users are expected to use mqeFields_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 mqeMsg_getOriginQMgr MQeMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phOutQMgrName
 

Parameters:
hMsg  [in] the message to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phOutQMgrName  [out] Pointer to handle for output string.
Precondition:
hMsg must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOutQMgrName must point to an existing handle.
Returns :
output in hOutQMgrName.
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeString_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 mqeMsg_getTimeStamp MQeMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQEINT64 *    pOutTimeStamp
 

Parameters:
hMsg  [in] the message to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pOutTimeStamp  [out] Pointer to a variable for output.
Precondition:
hMsg must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOutTimeStamp must point to an existing MQEINT64.
Returns :
output in (*phOutTimeStamp).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeMsg_resetMsgUIDFields MQeMsgHndl    hMsg,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsg  [in] the message to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
Precondition:
hMsg must not be NULL.
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:21 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference