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

MQe_FieldEnum.h File Reference

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


Functions

MQERETURN mqeFieldEnumeration_hasMore (MQeFieldEnumerationHndl hFieldEnumeration, MQeExceptBlock *pErrStruct, MQEBOOL *pMore)
 This function determines if there are more field elements in hFieldEnumeration. If there are more fields (*pMore) is assigned a value of MQE_TRUE; otherwise, (*pMore) is assigned MQE_FALSE.

MQERETURN mqeFieldEnumeration_next (MQeFieldEnumerationHndl hFieldEnum, MQeExceptBlock *pErrStruct, MQeStringHndl *phFieldName)
 This function gets the name of the current field name pointed by the internal pointer in hFieldEnumeration.

MQERETURN mqeFieldEnumeration_free (MQeFieldEnumerationHndl hFieldEnumeration, MQeExceptBlock *pErrStruct)
 This function frees the hFieldEnumeration MQeFieldEnumerationHndl object.


Detailed Description

This page describes MQeFieldEnumeration C API prototypes.


Function Documentation

MQERETURN mqeFieldEnumeration_hasMore MQeFieldEnumerationHndl    hFieldEnumeration,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pMore
 

Parameters:
hFieldEnumeration  [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 mqeFieldEnumeration_next MQeFieldEnumerationHndl    hFieldEnum,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phFieldName
 

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

MQERETURN mqeFieldEnumeration_free MQeFieldEnumerationHndl    hFieldEnumeration,
MQeExceptBlock   pErrStruct
 

Parameters:
hFieldEnumeration  [in] 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:18 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference