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

MQe_MsgEnum.h File Reference

The MQSeries Everyplace MessageEnumeration class C API header file for Java bindings. More...


Functions

MQERETURN mqeMessageEnumeration_hasMore (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct, MQEBOOL *pMore)
 This function determines if there is a next message element in hMessageEnumeration. If so, (*pMore) is assigned a value of MQE_TRUE; otherwise, (*pMore) is assigned MQE_FALSE.

MQERETURN mqeMessageEnumeration_containsJustUID (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct, MQEBOOL *pJustUID)
 This function determines if hMessageEnumeration contains justUID (a result of browse with justUID flag set). If so, (*pJustUID) is assigned a value of MQE_TRUE; otherwise, (*pMore) is assigned MQE_FALSE.

MQERETURN mqeMessageEnumeration_next (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phFields)
 This function gets the current message pointed by the internal pointer in hMessageEnumeration.

MQERETURN mqeMessageEnumeration_getLockId (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct, MQEINT64 *pLockId)
 This function returns the lock id associated with the group of messages contained in hMessageEnumeration (-1 if not set).

MQERETURN mqeMessageEnumeration_getQueueManagerName (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct, MQeStringHndl *phQueueManagerName)
 This function returns the name of the queue manager that owns the queue from which the messages contained in hMessageEnumeration were browsed.

MQERETURN mqeMessageEnumeration_getQueueName (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct, MQeStringHndl *phQueueName)
 This function returns the name of the queue from which the messages contained in hMessageEnumeration were browsed.

 mqeMessageEnumeration_free (MQeMessageEnumerationHndl hMessageEnumeration, MQeExceptBlock *pErrStruct)
 This function frees the hMessageEnumeration MQeMessageEnumerationHndl object.


Detailed Description

It describes MQeMessageEnumeration C API prototypes.

Please note the following


Function Documentation

MQERETURN mqeMessageEnumeration_hasMore MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pMore
 

Parameters:
hMessageEnumeration  [in] field enumeration to be checked.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pMore  [out] Pointer to result variable.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*pMore).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEnumeration_containsJustUID MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pJustUID
 

Parameters:
hMessageEnumeration  [in] field enumeration to be checked.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pJustUID  [out] Pointer to result variable.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*pJustUID).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEnumeration_next MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phFields
 

Parameters:
hMessageEnumeration  [in] message enumeration to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phFields  [out] Pointer to result MQeFields (could actually be an MQeMsg if it is a result of a browse with justUID flag unset).
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*phFields).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEnumeration_getLockId MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct,
MQEINT64 *    pLockId
 

Parameters:
hMessageEnumeration  [in] field enumeration to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pLockId  [out] Pointer to result variable.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*pLockId).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMessageEnumeration_getQueueManagerName MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phQueueManagerName
 

Parameters:
hMessageEnumeration  [in] field enumeration to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phQueueManagerName  [out] Pointer to handle for result 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 mqeMessageEnumeration_getQueueName MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phQueueName
 

Parameters:
hMessageEnumeration  [in] field enumeration to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phQueueName  [out] Pointer to handle for result 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

mqeMessageEnumeration_free MQeMessageEnumerationHndl    hMessageEnumeration,
MQeExceptBlock   pErrStruct
 

Parameters:
hMessageEnumeration  [in] the enumeration 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 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized


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