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

MQe_Fields.h File Reference


Detailed Description

API header file for MQeFields.

MQeFields is the fundamental class used to hold data items for sending, receiving, or manipulating WebSphereMQ Everyplace messages. An MQeFields object is constructed as follows:

 * MQeFieldsHndl hNewFields;
 * MQERETURN rc;
 * rc = mqeFields_new(&errStruct, &hNewFields);
 * 

There are various put and get functions for storing and retrieving items in/from MQeFields. Items are held in a name, type and value form. The name must conform to the following rules:

The MQeFields name is used to retrieve and update values. It is good practice to keep names short, because the names are included with the data when the MQeFields item is dumped.


Functions

MQERETURN mqeFields_new (MQeExceptBlock *pErrStruct, MQeFieldsHndl *phNewFields)
 This function constructs and initializes an MQeFields structure.

MQERETURN mqeFields_free (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct)
 Frees the MQeFields pointed to by hFields.

MQERETURN mqeFields_contains (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBOOL *pContains, MQECONST MQeStringHndl hFieldName)
 This function determines if a field is in this MQeFields structure.

MQERETURN mqeFields_copy (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hFrom, MQEBOOL replace, MQECONST MQeStringHndl hFieldName)
 This function copies all hFrom field items (or just hFieldName, if hFieldName is not NULL) to hFields.

MQERETURN mqeFields_clone (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phToFields)
 This function clones all hFields field entries to *phToFields.

MQERETURN mqeFields_dataLength (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEINT32 *pSize)
 This function returns the length (in bytes) of the field element data in hFieldname.

MQERETURN mqeFields_dataType (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEFIELDTYPE *pType, MQECONST MQeStringHndl hFieldName)
 This function extracts field data type of field hFieldName in hFields.

MQERETURN mqeFields_delete (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName)
 This function removes a field from hFields.

MQERETURN mqeFields_dump (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBYTE *pBytes, MQEINT32 *pSize)
 This function dumps all fields to a byte array ((*pBytes) ).

MQERETURN mqeFields_isEqualTo (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBOOL *pEquals, MQECONST MQeFieldsHndl hMatch)
 This function checks if hMatch is equal to hFields.

MQERETURN mqeFields_includes (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBOOL *pEquals, MQECONST MQeFieldsHndl hMatch)
 This function checks if hFields contains all fields in hMatch.

MQERETURN mqeFields_dumpToDynBuf (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeDynamicBufferHndl hOutput)
 This function dumps all fields to a dynamic buffer. If a security attribute has been attached (by calling mqeFields_setAttribute()), the MQeFields item will be encoded using the attribute.

MQERETURN mqeFields_fields (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeVectorHndl *phVector)
 This function returns the identifiers of all fields in hFields.

MQERETURN mqeFields_setClassName (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeStringHndl hClassName)
 This function sets or resets the class name in hFields.

MQERETURN mqeFields_getClassName (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeStringHndl *phClassName)
 This function gets the class name in hFields.

MQERETURN mqeFields_getAscii (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeStringHndl *phString, MQECONST MQeStringHndl hFieldName)
 This function gets a string field (hFieldName) stored in hFields and returns it as an MQeString.

MQERETURN mqeFields_getAsciiArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeStringHndl *phStrings, MQEINT32 *pArrSize, MQECONST MQeStringHndl hFieldName)
 This function gets an array of string fields (hFieldName) stored in hFields and returns it as an array of MQeString handles.

MQERETURN mqeFields_getUnicode (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeStringHndl *phString, MQECONST MQeStringHndl hFieldName)
 This function gets a string field (hFieldName) stored in hFields and returns it as a double-byte UNICODE string in MQeString.

MQERETURN mqeFields_getUnicodeArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeStringHndl *phStrings, MQEINT32 *pArrSize, MQECONST MQeStringHndl hFieldName)
 This function gets an array of string fields (hFieldName) stored in hFields and returns it as an array of double-byte Unicode strings.

MQERETURN mqeFields_getAttribute (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeFieldsAttrHndl *phAttribute)
 This function gets the current attribute setting of hFields.

MQERETURN mqeFields_getBoolean (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBOOL *pBool, MQECONST MQeStringHndl hFieldName)
 This function gets a boolean field value in hFields.

MQERETURN mqeFields_getByte (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBYTE *pByte, MQECONST MQeStringHndl hFieldName)
 This function gets a byte hFieldName stored in hFields.

MQERETURN mqeFields_getByteArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBYTE **ppBytes, MQEINT32 *pByteSeqLens, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets an array of byte sequences hFieldName stored in hFields.

MQERETURN mqeFields_getDouble (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEDOUBLE *pDouble, MQECONST MQeStringHndl hFieldName)
 This function gets a double hFieldName stored in hFields.

MQERETURN mqeFields_getFields (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phOutputFields, MQECONST MQeStringHndl hFieldName)
 This function gets fields item hFieldName stored in hFields.

MQERETURN mqeFields_getFieldsArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phOutputFields, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets an array of fields hFieldName stored in hFields.

MQERETURN mqeFields_getFloat (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEFLOAT *pFloat, MQECONST MQeStringHndl hFieldName)
 This function gets a float hFieldName stored in hFields.

MQERETURN mqeFields_getInt32 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT32 *pInt32, MQECONST MQeStringHndl hFieldName)
 This function gets an int32 hFieldName stored in hFields.

MQERETURN mqeFields_getInt64 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT64 *pInt64, MQECONST MQeStringHndl hFieldName)
 This function gets an int64 hFieldName stored in hFields.

MQERETURN mqeFields_getInt16 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT16 *pInt16, MQECONST MQeStringHndl hFieldName)
 This function gets an int16 hFieldName stored in hFields.

MQERETURN mqeFields_putAscii (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQeStringHndl hString)
 This function puts an Ascii string (via MQeString) named hFieldName into hFields.

MQERETURN mqeFields_putAsciiArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQeStringHndl *phStrings, MQEINT32 arrSize)
 This function puts an array of Ascii strings (via MQeString array) named hFieldName into hFields.

MQERETURN mqeFields_putUnicode (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQeStringHndl hString)
 This function puts a double-byte UNICODE string (terminated by 0x0000) named hFieldName into hFields.

MQERETURN mqeFields_putUnicodeArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQeStringHndl *phStrings, MQEINT32 arrSize)
 This function puts an array of double-byte UNICODE strings (via MQeString array) named hFieldName into hFields.

MQERETURN mqeFields_putBoolean (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEBOOL b)
 This function puts a boolean field value named hFieldName into hFields.

MQERETURN mqeFields_putByte (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEBYTE input)
 This function puts a byte named hFieldName into hFields.

MQERETURN mqeFields_putByteArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEBYTE **ppBytes, MQECONST MQEINT32 *pLenOfByteSeqs, MQEINT32 arrLength)
 This function puts a sequence of bytes named hFieldName into hFields.

MQERETURN mqeFields_putDouble (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEDOUBLE input)
 This function puts a double named hFieldName into hFields.

MQERETURN mqeFields_putFloat (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEFLOAT input)
 This function puts a float named hFieldName into hFields.

MQERETURN mqeFields_putInt32 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEINT32 input)
 This function puts an int32 named hFieldName into hFields.

MQERETURN mqeFields_putInt64 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEINT64 input)
 This function puts an int64 named hFieldName into hFields.

MQERETURN mqeFields_putInt16 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQEINT16 input)
 This function puts an int16 named hFieldName into hFields.

MQERETURN mqeFields_putFields (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQeFieldsHndl hInputFields)
 This function puts an MQeFields named hFieldName into hFields.

MQERETURN mqeFields_putFieldsArray (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQeFieldsHndl *phInputFields, MQEINT32 arrLength)
 This function puts an array of Fields named hFieldName into hFields.

MQERETURN mqeFields_rename (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hOrgName, MQECONST MQeStringHndl hNewName)
 This function renames a field hOrgName stored in hFields to hNewName.

MQERETURN mqeFields_restore (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBYTE *pData, MQEINT32 size)
 This function restores a fields item from byte array (*pData). If a security attribute has been attached (by calling mqeFields_setAttribute()), the input bytes will be decoded using the attribute.

MQERETURN mqeFields_setAttribute (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsAttrHndl hAttribute)
 This function sets the attribute setting of hFields to hAttribute.

MQERETURN mqeFields_getArrayLength (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function returns the length (number of array elements) of the array in hFieldname.

MQERETURN mqeFields_putDoubles (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEDOUBLE *pDoubles, MQEINT32 arrLength, MQEBOOL multiFieldsRep)
 This function puts a sequence of doubles named hFieldName into hFields.

MQERETURN mqeFields_putFloats (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEFLOAT *pFloats, MQEINT32 arrLength, MQEBOOL multiFieldsRep)
 This function puts a sequence of floats named hFieldName into hFields.

MQERETURN mqeFields_putInt32s (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEINT32 *pInt32s, MQEINT32 arrLength, MQEBOOL multiFieldsRep)
 This function puts a sequence of int32s named hFieldName into hFields.

MQERETURN mqeFields_putInt64s (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEINT64 *pInt64s, MQEINT32 arrLength, MQEBOOL multiFieldsRep)
 This function puts a sequence of int64s named hFieldName into hFields.

MQERETURN mqeFields_putInt16s (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEINT16 *pInt16s, MQEINT32 arrLength, MQEBOOL multiFieldsRep)
 This function puts a sequence of int16s named hFieldName into hFields.

MQERETURN mqeFields_putBytes (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEBYTE *pBytes, MQEINT32 arrLength)
 This function puts a sequence of bytes named hFieldName into hFields.

MQERETURN mqeFields_getDoubles (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEDOUBLE *pDoubles, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of doubles hFieldName stored in hFields.

MQERETURN mqeFields_getFloats (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEFLOAT *pFloats, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of floats hFieldName stored in hFields.

MQERETURN mqeFields_getInt32s (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT32 *pInt32s, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of int32s hFieldName stored in hFields.

MQERETURN mqeFields_getInt64s (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT64 *pInt64s, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of int64s hFieldName stored in hFields.

MQERETURN mqeFields_getInt16s (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT16 *pInt16s, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of int16s hFieldName stored in hFields.

MQERETURN mqeFields_getBytes (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBYTE *pBytes, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of bytes hFieldName stored in hFields.

MQERETURN mqeFields_putArrayOfByte (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEBYTE *pBytes, MQEINT32 arrLength)
 This function puts a sequence of bytes named hFieldName into hFields.

MQERETURN mqeFields_putArrayOfDouble (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEDOUBLE *pDoubles, MQEINT32 arrLength)
 This function puts a sequence of doubles named hFieldName into hFields.

MQERETURN mqeFields_putArrayOfFloat (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEFLOAT *pFloats, MQEINT32 arrLength)
 This function puts a sequence of floats named hFieldName into hFields.

MQERETURN mqeFields_putArrayOfInt32 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEINT32 *pInt32s, MQEINT32 arrLength)
 This function puts a sequence of int32s named hFieldName into hFields.

MQERETURN mqeFields_putArrayOfInt64 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEINT64 *pInt64s, MQEINT32 arrLength)
 This function puts a sequence of int64s named hFieldName into hFields.

MQERETURN mqeFields_putArrayOfInt16 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hFieldName, MQECONST MQEINT16 *pInt16s, MQEINT32 arrLength)
 This function puts a sequence of int16s named hFieldName into hFields.

MQERETURN mqeFields_getArrayOfByte (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEBYTE *pBytes, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of bytes hFieldName stored in hFields.

MQERETURN mqeFields_getArrayOfDouble (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEDOUBLE *pDoubles, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of doubles hFieldName stored in hFields.

MQERETURN mqeFields_getArrayOfFloat (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEFLOAT *pFloats, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of floats hFieldName stored in hFields.

MQERETURN mqeFields_getArrayOfInt32 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT32 *pInt32s, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of int32s hFieldName stored in hFields.

MQERETURN mqeFields_getArrayOfInt64 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT64 *pInt64s, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of int64s hFieldName stored in hFields.

MQERETURN mqeFields_getArrayOfInt16 (MQeFieldsHndl hFields, MQeExceptBlock *pErrStruct, MQEINT16 *pInt16s, MQEINT32 *pArrLength, MQECONST MQeStringHndl hFieldName)
 This function gets a sequence of int16s hFieldName stored in hFields.


Function Documentation

MQERETURN mqeFields_new MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phNewFields
 

This function constructs and initializes an MQeFields structure.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phNewFields  [out] Pointer to the new MQeFields handle
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_ALLOCATION_FAILED 
  • Memory allocation failed
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER - NULL phNewFields
Warning:
Users are expected to use mqeFields_free() to free the structure 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 mqeFields_free MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct
 

Frees the MQeFields pointed to by hFields.

Parameters:
hFields  [in] MQeFields 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 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_contains MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pContains,
MQECONST MQeStringHndl    hFieldName
 

This function determines if a field is in this MQeFields structure.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pContains  [out] Pointer to a variable for the result
hFieldName  [in] Name (as ASCII only characters in MQeString) of the field to query
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pContains must point to an MQEBOOL variable.
hFieldName must not be NULL.
Returns :
(*pContains).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pContains/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_copy MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeFieldsHndl    hFrom,
MQEBOOL    replace,
MQECONST MQeStringHndl    hFieldName
 

This function copies all hFrom field items (or just hFieldName, if hFieldName is not NULL) to hFields.

Parameters:
hFields  [in] MQeFields to which data is to be copied
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFrom  [in] MQeFields from which data is to be copied
replace  [in] If a field named hFieldName already exists in hFields, if replace is true, the original value of the field is replaced; otherwise, an error is returned.
hFieldName  [in] If only a particular field is to be copied, the name (as ASCII only characters in MQeString) of the field (set hFieldName to NULL if the entire hFrom is to be copied).
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct_ is NULL).
Returns :
hFields.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFrom
  • MQEREASON_API_INVALID_SIGNATURE hFields/hFrom not an MQeFields

MQERETURN mqeFields_clone MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phToFields
 

This function clones all hFields field entries to *phToFields.

Parameters:
hFields  [in] MQeFields to be cloned
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phToFields  [out] Pointer to the output MQeFields
Precondition:
hFields phToFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
Returns :
(*phToFields).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phToFields
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
Warning:
If an attribute has been attached to hFields, the newly generated MQeFields will reference the same attribute attached to hFields instead of referencing a cloned attribute.

MQERETURN mqeFields_dataLength MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEINT32 *    pSize
 

This function returns the length (in bytes) of the field element data in hFieldname.

Parameters:
hFields  the MQeFields in question.
pErrStruct  pointer to a pre-allocated MQeExceptBlock structure.
hFieldName  the name (as ASCII only characters in MQeString) of the field in question.
pSize  pointer to an MQEINT32 field to receive the length.
Precondition:
hFields hFieldName must not be NULL.
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Returns :
(*pSize).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQEREASON_NA MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_dataType MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEFIELDTYPE *    pType,
MQECONST MQeStringHndl    hFieldName
 

This function extracts field data type of field hFieldName in hFields.

Parameters:
hFields  [in] MQeFields to be queried
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pType  [out] Pointer to result variable
hFieldName  [in] Name (as ASCII only characters in MQeString) of the field to be queried
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pType must point to an MQEFIELDTYPE variable.
hFieldName must not be NULL.
Returns :
(*pType).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pType/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_delete MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName
 

This function removes a field from hFields.

Parameters:
hFields  [in] MQeFields to be removed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Name (as ASCII only characters in MQeString) of the field to be removed
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must not be NULL.
Return values:
MQERETURN_OK 
  • Operation successful
Note:
If the hFieldName indicates an array (of fields), the entire array is deleted.

MQERETURN mqeFields_dump MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBytes,
MQEINT32 *    pSize
 

This function dumps all fields to a byte array ((*pBytes) ).

Deprecated:
If a security attribute has been attached (by calling mqeFields_setAttribute()), the MQeFields item will be encoded using the attribute.
Parameters:
hFields  [in] MQeFields to be dumped
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBytes  [in/out] Pointer to a byte array for output
pSize  [in/out] Pointer to size of (*pBytes)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pBytes must point to an existing byte array.
Returns :
(*pBytes) and (*pSize):
 * ----------------- ------------------ ---------------------- -------------------------
 * initial (*pSize)  initial (*pBytes)  returned (*pSize)      returned (*pBytes)
 * ----------------- ------------------ ---------------------- -------------------------
 * <= 0              any                buffer sizes required  not defined 
 *                                      (number of bytes)
 * any               NULL               ditto                  ditto
 * > 0               != NULL            buffer space used      bytes
 *                                      (number of bytes)
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pSize
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_BUFFER_OVERFLOW 
  • Supplied buffer not big enough

MQERETURN mqeFields_isEqualTo MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pEquals,
MQECONST MQeFieldsHndl    hMatch
 

This function checks if hMatch is equal to hFields.

Parameters:
hFields  [in] MQeFields to be matched
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pEquals  [out] Pointer to an MQEBOOL variable for output
hMatch  [in] MQeFields containing items to be used for a comparison
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pEquals must point to an existing variable.
Returns :
(*pEquals).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pEquals/hMatch
  • MQEREASON_API_INVALID_SIGNATURE hFields/hMatch not an MQeFields

MQERETURN mqeFields_includes MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pEquals,
MQECONST MQeFieldsHndl    hMatch
 

This function checks if hFields contains all fields in hMatch.

Parameters:
hFields  [in] MQeFields to be queried
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pEquals  [out] Pointer to an MQEBOOL variable for output
hMatch  [in] MQeFields containing items to be used for a comparison
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pEquals must point to an existing variable.
Returns :
(*pEquals).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pEquals/hMatch
  • MQEREASON_API_INVALID_SIGNATURE hFields/hMatch not an MQeFields

MQERETURN mqeFields_dumpToDynBuf MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeDynamicBufferHndl    hOutput
 

This function dumps all fields to a dynamic buffer. If a security attribute has been attached (by calling mqeFields_setAttribute()), the MQeFields item will be encoded using the attribute.

Parameters:
hFields  [in] MQeFields to be dumped
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hOutput  [in/out] output dynamic buffer handle
Precondition:
hFields 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 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pSize
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_fields MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeVectorHndl *    phVector
 

This function returns the identifiers of all fields in hFields.

Parameters:
hFields  [in] MQeFields to be queried
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phVector  [out] Pointer to result handle
Precondition:
hFields must not be NULL.
pErrStruct must point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
phVector must not be NULL.
Returns :
(*phVector)
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQEREASON_NA MQeSession_initialize() not yet called

MQERETURN mqeFields_setClassName MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hClassName
 

This function sets or resets the class name in hFields.

Parameters:
hFields  the MQeFields in question.
pErrStruct  pointer to a pre-allocated MQeExceptBlock structure.
hClassName  handle to the class name (e.g. "com.ibm.mqe.MQeFields")
Precondition:
hFields hClassName must not be NULL.
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQEREASON_NA MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hClassName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_getClassName MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phClassName
 

This function gets the class name in hFields.

Parameters:
hFields  the MQeFields in question.
pErrStruct  pointer to a pre-allocated MQeExceptBlock structure.
phClassName  pointer to output handle
Precondition:
hFields and phClassName must not be NULL.
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQEREASON_NA MQeSession_initialize() not yet called

MQERETURN mqeFields_getAscii MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phString,
MQECONST MQeStringHndl    hFieldName
 

This function gets a string field (hFieldName) stored in hFields and returns it as an MQeString.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phString  [out] Pointer to the MQeString handle
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the string
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*phString).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phString/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Warning:
Users are expected to use mqeString_free() to free the string 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 mqeFields_getAsciiArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phStrings,
MQEINT32 *    pArrSize,
MQECONST MQeStringHndl    hFieldName
 

This function gets an array of string fields (hFieldName) stored in hFields and returns it as an array of MQeString handles.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phStrings  [in/out] Pointer to the result MQeString handles
pArrSize  [in/out] Pointer to number of elements in array (*phStrings)
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pArrSize must not be NULL.
Returns :
(*phStrings) and (*pArrSize).
 * -------------------- ------------------  ---------------------  -------------------
 * initial (*pArrSize)  initial phStrings   returned (*pArrSize)   returned phStrings
 * -------------------- ------------------  ---------------------  -------------------
 * <= 0                 any                 number of elements in  not defined
 *                                          the array
 * any                  NULL                ditto                  ditto
 *
 * > 0                  != NULL             ditto                  points to the array
 *                                                                 of MQeString handles
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phStrings/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Warning:
Users are expected to use mqeString_free() to free the MQeStrings returned by this call after they are no longer needed. This enables reuse of system resources and can help to avoid system problems caused by shortage of resources.

MQERETURN mqeFields_getUnicode MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phString,
MQECONST MQeStringHndl    hFieldName
 

This function gets a string field (hFieldName) stored in hFields and returns it as a double-byte UNICODE string in MQeString.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phString  [out] Pointer to the result MQeString handle
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the string
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*phString).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phString/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Warning:
Users are expected to use mqeString_free() to free the MQeString 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 mqeFields_getUnicodeArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phStrings,
MQEINT32 *    pArrSize,
MQECONST MQeStringHndl    hFieldName
 

This function gets an array of string fields (hFieldName) stored in hFields and returns it as an array of double-byte Unicode strings.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phStrings  [in/out] Pointer to the result MQeString handle array
pArrSize  [in/out] Number of elements in array (*phStrings)
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the string
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pArrSize must not be NULL.
Returns :
(*phStrings) and (*pArrSize).
 * -------------------- ------------------  --------------------- -------------------
 * initial (*pArrSize)  initial phStrings   returned (*pArrSize)  returned phStrings
 * -------------------- ------------------  --------------------- -------------------
 * <= 0                 any                 number of elements in not defined
 *                                          the array
 * any                  NULL                ditto                 ditto
 *
 * > 0                  != NULL             ditto                 points to the array    
 *                                                                of MQeString handles
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phStrings/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Warning:
Users are expected to use mqeString_free() to free the MQeStrings 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 mqeFields_getAttribute MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeFieldsAttrHndl *    phAttribute
 

This function gets the current attribute setting of hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phAttribute  [out] Pointer to the result MQeAttribute handle
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
phAttribute must point to an existing handle.
Returns :
(*phAttribute).
Return values:
MQERETURN_OK  Operation successful
Warning:
Users are expected to use mqeAttribute_free() to free the MQeAttribute 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 mqeFields_getBoolean MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pBool,
MQECONST MQeStringHndl    hFieldName
 

This function gets a boolean field value in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBool  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pBool).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pBool
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getByte MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pByte,
MQECONST MQeStringHndl    hFieldName
 

This function gets a byte hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pByte  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pByte).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pByte/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getByteArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBYTE **    ppBytes,
MQEINT32 *    pByteSeqLens,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets an array of byte sequences hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
ppBytes  [in/out] Pointer to the result buffer pointers
pByteSeqLens  [in/out] Lengths of output byte sequences
pArrLength  [in/out] Pointer to the length (number of elements) of (*ppBytes) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*ppBytes), (*pByteSeqLens) and (*pArrLength):
 * ---------------------- ------------------------ ------------------ ----------------------- --------------------------- -------------------
 * initial (*pArrLength)  initial pByteSeqLens[i]  initial ppBytes    returned (*pArrLength)  pByteSeqLens[i]             returned ppBytes
 * ---------------------- ------------------------ ------------------ ----------------------- --------------------------- -------------------
 * <= 0                   any                      any                number of byte          not defined                 not defined
 *                                                                    sequences in the array
 * > 0                    <= 0                     any                ditto                   size of buffer (number of   ditto
 *                                                                                            bytes) required
 *                                                                                            for byte sequence 
 * > 0                    > 0                      != NULL            ditto                   ditto                       points to the results
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/ppBytes/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Note:
This API function is capable of retrieving MQEBYTE arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.

MQERETURN mqeFields_getDouble MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEDOUBLE *    pDouble,
MQECONST MQeStringHndl    hFieldName
 

This function gets a double hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pDouble  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pDouble):
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pDouble/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getFields MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phOutputFields,
MQECONST MQeStringHndl    hFieldName
 

This function gets fields item hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phOutputFields  [out] Pointer to an MQeFields handle for output
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
phOutputFields must point to an existing handle.
hFieldName must point to an existing handle.
Returns :
(*phOutputFields).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phOutputFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Warning:
Users are expected to use mqeFields_free() to free the MQeFields 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 mqeFields_getFieldsArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQeFieldsHndl *    phOutputFields,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets an array of fields hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phOutputFields  [in/out] Pointer to an MQeFields handle for output.
pArrLength  [in/out] size of array (*phOutputFields).
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the MQeFields to be returned.
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*phOutputFields) and (*pArrLength):
 * ---------------------- -------------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*phOutputFields)  returned (*pArrLength)  returned (*phOutputFields)
 * ---------------------- -------------------------- ----------------------- -------------------------
 * <= 0                   any                        buffer sizes required   not defined 
 *                                                   (number of elements)
 * any                    NULL                       ditto                   ditto
 * > 0                    != NULL                    buffer space used       Fields
 *                                                   (number of elements)
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/phOutputFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Warning:
Users are expected to use mqeFields_free() to free the MQeFields returned by this call after they are no longer needed. This enables reuse of system resources and can help to avoid system problems caused by shortage of resources.

MQERETURN mqeFields_getFloat MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEFLOAT *    pFloat,
MQECONST MQeStringHndl    hFieldName
 

This function gets a float hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pFloat  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pFloat):
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pFloat/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getInt32 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT32 *    pInt32,
MQECONST MQeStringHndl    hFieldName
 

This function gets an int32 hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt32  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pInt32):
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt32/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getInt64 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT64 *    pInt64,
MQECONST MQeStringHndl    hFieldName
 

This function gets an int64 hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt64  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pInt64).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt64/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getInt16 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT16 *    pInt16,
MQECONST MQeStringHndl    hFieldName
 

This function gets an int16 hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt16  [out] Pointer to the result variable
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Returns :
(*pInt16):
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt16/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_putAscii MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQeStringHndl    hString
 

This function puts an Ascii string (via MQeString) named hFieldName into hFields.

Parameters:
hFields  [in/out] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the string
hString  [in] Handle for the input Ascii string (as MQeString)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hString and hFieldName must point to existing handles.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/hString
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putAsciiArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQeStringHndl *    phStrings,
MQEINT32    arrSize
 

This function puts an array of Ascii strings (via MQeString array) named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
phStrings  [in] Pointer to the MQeString handle array
arrSize  [in] Number of elements in array (*phStrings)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
phStrings and hFieldName must point to existing handles.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/phStrings
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putUnicode MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQeStringHndl    hString
 

This function puts a double-byte UNICODE string (terminated by 0x0000) named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the string
hString  [in] Handle for the input double-byte UNICODE string (in MQeString)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hString and hFieldName must point to existing strings.
Return values:
MQERETURN_OK  Operation successful
MQERETURN_SESSION_NOT_INITIALIZED  MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/hString
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putUnicodeArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQeStringHndl *    phStrings,
MQEINT32    arrSize
 

This function puts an array of double-byte UNICODE strings (via MQeString array) named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the string
phStrings  [in] Pointer to the MQeString handle array
arrSize  [in] Number of elements in array (*phStrings)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName and phStrings must point to existing string / array of strings.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/phStrings
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putBoolean MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEBOOL    b
 

This function puts a boolean field value named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
b  [in] Input value
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putByte MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEBYTE    input
 

This function puts a byte named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
input  [in] Byte to be put
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putByteArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEBYTE **    ppBytes,
MQECONST MQEINT32 *    pLenOfByteSeqs,
MQEINT32    arrLength
 

This function puts a sequence of bytes named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
ppBytes  [in] Pointer to the input buffer
pLenOfByteSeqs  [in] Array indicating the lengths of input byte sequences pointed to by ppBytes
arrLength  [in] Length (number of elements) of (*ppBytes) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/ppBytes
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putDouble MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEDOUBLE    input
 

This function puts a double named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
input  [in] Double to be put
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putFloat MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEFLOAT    input
 

This function puts a float named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
input  [in] Float to be put
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putInt32 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEINT32    input
 

This function puts an int32 named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
input  [in] Int32 to be put
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putInt64 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEINT64    input
 

This function puts an int64 named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
input  [in] Int64 to be put
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putInt16 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQEINT16    input
 

This function puts an int16 named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the field
input  [in] Int16 to be put
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putFields MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQeFieldsHndl    hInputFields
 

This function puts an MQeFields named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the Fields field
hInputFields  [in] Handle to Websphere MQEveryplace fields item to add
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hInputFields must point to an existing fields item.
hFieldName must point to an existing handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/hInputFields
  • MQEREASON_API_INVALID_SIGNATURE hFields/hInputFields not an MQeFields

MQERETURN mqeFields_putFieldsArray MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQeFieldsHndl *    phInputFields,
MQEINT32    arrLength
 

This function puts an array of Fields named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the Fields field
phInputFields  [in] Pointer to Fields handles
arrLength  [in] Length of (*phIntputFields)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
phIntputFields must point to an existing array.
hFieldName must point to an existing Handle.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/phInputFields
  • MQEREASON_API_INVALID_SIGNATURE hFields/hInputFields not MQeFields

MQERETURN mqeFields_rename MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hOrgName,
MQECONST MQeStringHndl    hNewName
 

This function renames a field hOrgName stored in hFields to hNewName.

Parameters:
hFields  [in/out] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hOrgName  [in] Handle for the orignal name (as ASCII only characters in MQeString) of the field
hNewName  [in] Handle for the new name (as ASCII only characters in MQeString) of the field
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hOrgName and hNewName must point to existing strings.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hNewName/hOrgName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_restore MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pData,
MQEINT32    size
 

This function restores a fields item from byte array (*pData). If a security attribute has been attached (by calling mqeFields_setAttribute()), the input bytes will be decoded using the attribute.

Parameters:
hFields  [in/out] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pData  [in] Pointer to the source data array
size  [in] Size of data (in bytes) in (*pData)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pData must point to an existing array.
Returns :
hFields.
Return values:
MQERETURN_OK  Operation successful
MQERETURN_SESSION_NOT_INITIALIZED  MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pData
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_setAttribute MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeFieldsAttrHndl    hAttribute
 

This function sets the attribute setting of hFields to hAttribute.

Parameters:
hFields  [in/out] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hAttribute  [in] Handle for input attributes
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hAttribute must point to an existing handle.
Return values:
MQERETURN_OK  Operation successful
MQERETURN_SESSION_NOT_INITIALIZED  MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hAttribute
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields/hAttribute not an MQeAttribute

MQERETURN mqeFields_getArrayLength MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function returns the length (number of array elements) of the array in hFieldname.

Parameters:
hFields  [in] the MQeFields in question.
pErrStruct  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
pArrLength  [in/out] pointer to an MQEINT32 field to receive the length.
hFieldName  [in] the name (as ASCII only characters in MQeString) of the field in question.
Precondition:
hFields hFieldName must not be NULL.
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Returns :
(*pArrLength).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQEREASON_NA MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pArrLength
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putDoubles MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEDOUBLE *    pDoubles,
MQEINT32    arrLength,
MQEBOOL    multiFieldsRep
 

This function puts a sequence of doubles named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pDoubles  [in] The input array
arrLength  [in] Length (number of elements) of (*pDoubles) array
multiFieldsRep  [in] Whether the array is to be represented internally by a set of fields (equivalent to the Java putDoubleArray() method) or by a single field (equivalent to the Java putArrayOfDouble() method).
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pDoubles can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pDoubles
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
Note:
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_putArrayOfDouble() for putting an array into a single field.

MQERETURN mqeFields_putFloats MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEFLOAT *    pFloats,
MQEINT32    arrLength,
MQEBOOL    multiFieldsRep
 

This function puts a sequence of floats named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pFloats  [in] The input array
arrLength  [in] Length (number of elements) of (*pFloats) array
multiFieldsRep  [in] Whether the array is to be represented internally by a set of fields (equivalent to the Java putFloatArray() method) or by a single field (equivalent to the Java putArrayOfFloat() method).
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pFloats can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pFloats
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
Note:
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_putArrayOfFloat() for putting an array into a single field.

MQERETURN mqeFields_putInt32s MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEINT32 *    pInt32s,
MQEINT32    arrLength,
MQEBOOL    multiFieldsRep
 

This function puts a sequence of int32s named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pInt32s  [in] The input array
arrLength  [in] Length (number of elements) of (*pInt32s) array
multiFieldsRep  [in] Whether the array is to be represented internally by a set of fields (equivalent to the Java putIntArray() method) or by a single field (equivalent to the Java putArrayOfInt() method)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pInt32s can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pInt32s
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
Note:
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_putArrayOfInt32() for putting an array into a single field.

MQERETURN mqeFields_putInt64s MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEINT64 *    pInt64s,
MQEINT32    arrLength,
MQEBOOL    multiFieldsRep
 

This function puts a sequence of int64s named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pInt64s  [in] The input array
arrLength  [in] Length (number of elements) of (*pInt64s) array
multiFieldsRep  [in] Whether the array is to be represented internally by a set of fields (equivalent to the Java putLongArray() method) or by a single field (equivalent to the Java putArrayOfLong() method)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pInt64s can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pInt64s
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
Note:
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_putArrayOfInt64() for putting an array into a single field.

MQERETURN mqeFields_putInt16s MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEINT16 *    pInt16s,
MQEINT32    arrLength,
MQEBOOL    multiFieldsRep
 

This function puts a sequence of int16s named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pInt16s  [in] The input array
arrLength  [in] Length (number of elements) of (*pInt16s) array
multiFieldsRep  [in] Whether the array is to be represented internally by a set of fields (equivalent to the Java putShortArray() method) or by a single field (equivalent to the Java putArrayOfShort() method)
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pInt16s can not have a NULL value if arrLength > 0.
Returns :
modified hFields.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pInt16s
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
Note:
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_putArrayOfInt16() for putting an array into a single field.

MQERETURN mqeFields_putBytes MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEBYTE *    pBytes,
MQEINT32    arrLength
 

This function puts a sequence of bytes named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pBytes  [in] Pointer to the input buffer
arrLength  [in] Length (number of elements) of (*pBytes) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pBytes can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pBytes
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_getDoubles MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEDOUBLE *    pDoubles,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of doubles hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pDoubles  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pDoubles) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pDoubles) and (*pArrLength):
 * ---------------------- -------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pDoubles)  returned (*pArrLength)  returned (*pDoubles)
 * ---------------------- -------------------- ----------------------- -------------------------
 * <= 0                   any                  buffer sizes required   not defined 
 *
 * any                    NULL                 ditto                   ditto
 *
 * > 0                    != NULL              buffer space used       doubles
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pDoubles/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Note:
This API function is capable of retrieving MQEDOUBLE arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_getArrayOfDouble() instead.

MQERETURN mqeFields_getFloats MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEFLOAT *    pFloats,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of floats hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pFloats  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pFloats) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pFloats) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pFloats)  returned (*pArrLength)  returned (*pFloats)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       floats
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pFloats/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Note:
This API function is capable of retrieving MQEFLOAT arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_getArrayOfFloat() instead.

MQERETURN mqeFields_getInt32s MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT32 *    pInt32s,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of int32s hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt32s  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pInt32s) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pInt32s) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pInt32s)  returned (*pArrLength)  returned (*pInt32s)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       int32s
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt32s/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Note:
This API function is capable of retrieving MQEINT32 arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_getArrayOfInt32() instead.

MQERETURN mqeFields_getInt64s MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT64 *    pInt64s,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of int64s hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt64s  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pInt64s) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pInt64s) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pInt64s)  returned (*pArrLength)  returned (*pInt64s)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       int64s
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt64s/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH  Field type mismatch
Note:
This API function is capable of retrieving MQEINT64 arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_getArrayOfInt64() instead.

MQERETURN mqeFields_getInt16s MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT16 *    pInt16s,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of int16s hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt16s  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pInt16s) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pInt16s) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pInt16s)  returned (*pArrLength)  returned (*pInt16s)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       int16s
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt16s/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Note:
This API function is capable of retrieving MQEINT16 arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.
This function is deprecated as multi-fields representation is deprecated. Use mqeFields_getArrayOfInt16() instead.

MQERETURN mqeFields_getBytes MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBytes,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of bytes hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBytes  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pBytes) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pBytes) and (*pArrLength):
 * ---------------------- ------------------ ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pBytes)  returned (*pArrLength)  returned (*pBytes)
 * ---------------------- ------------------ ----------------------- -------------------------
 * <= 0                   any                buffer sizes required   not defined 
 *                                           (in bytes)
 * any                    NULL               ditto                   ditto
 *
 * > 0                    != NULL            buffer space used       bytes
 *                                           (in bytes)
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pBytes/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch
Note:
This API function is capable of retrieving MQEBYTE arrays represented internally by a single field or multiple fields created by the supplied C/Java Websphere MQEveryplace APIs.

MQERETURN mqeFields_putArrayOfByte MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEBYTE *    pBytes,
MQEINT32    arrLength
 

This function puts a sequence of bytes named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pBytes  [in] The input array
arrLength  [in] Length (number of elements) of (*pBytes) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pDoubles can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pBytes
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putArrayOfDouble MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEDOUBLE *    pDoubles,
MQEINT32    arrLength
 

This function puts a sequence of doubles named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pDoubles  [in] The input array
arrLength  [in] Length (number of elements) of (*pDoubles) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pDoubles can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pDoubles
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putArrayOfFloat MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEFLOAT *    pFloats,
MQEINT32    arrLength
 

This function puts a sequence of floats named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pFloats  [in] The input array
arrLength  [in] Length (number of elements) of (*pFloats) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pFloats can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pFloats
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putArrayOfInt32 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEINT32 *    pInt32s,
MQEINT32    arrLength
 

This function puts a sequence of int32s named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pInt32s  [in] The input array
arrLength  [in] Length (number of elements) of (*pInt32s) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pInt32s can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pInt32s
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putArrayOfInt64 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEINT64 *    pInt64s,
MQEINT32    arrLength
 

This function puts a sequence of int64s named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pInt64s  [in] The input array
arrLength  [in] Length (number of elements) of (*pInt64s) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pInt64s can not have a NULL value if arrLength > 0.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pInt64s
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_putArrayOfInt16 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hFieldName,
MQECONST MQEINT16 *    pInt16s,
MQEINT32    arrLength
 

This function puts a sequence of int16s named hFieldName into hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
pInt16s  [in] The input array
arrLength  [in] Length (number of elements) of (*pInt16s) array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
hFieldName must point to an existing handle.
pInt16s can not have a NULL value if arrLength > 0.
Returns :
modified hFields.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/hFieldName/pInt16s
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields

MQERETURN mqeFields_getArrayOfByte MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBytes,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of bytes hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBytes  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pBytes) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pBytes) and (*pArrLength):
 * ---------------------- -------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pBytes)  returned (*pArrLength)  returned (*pBytes)
 * ---------------------- -------------------- ----------------------- -------------------------
 * <= 0                   any                  buffer sizes required   not defined 
 *
 * any                    NULL                 ditto                   ditto
 *
 * > 0                    != NULL              buffer space used       bytes
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pBytes/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getArrayOfDouble MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEDOUBLE *    pDoubles,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of doubles hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pDoubles  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pDoubles) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pDoubles) and (*pArrLength):
 * ---------------------- -------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pDoubles)  returned (*pArrLength)  returned (*pDoubles)
 * ---------------------- -------------------- ----------------------- -------------------------
 * <= 0                   any                  buffer sizes required   not defined 
 *
 * any                    NULL                 ditto                   ditto
 *
 * > 0                    != NULL              buffer space used       doubles
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pDoubles/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getArrayOfFloat MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEFLOAT *    pFloats,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of floats hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pFloats  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pFloats) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pFloats) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pFloats)  returned (*pArrLength)  returned (*pFloats)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       floats
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pFloats/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getArrayOfInt32 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT32 *    pInt32s,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of int32s hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt32s  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pInt32s) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pInt32s) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pInt32s)  returned (*pArrLength)  returned (*pInt32s)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       int32s
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt32s/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch

MQERETURN mqeFields_getArrayOfInt64 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT64 *    pInt64s,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of int64s hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt64s  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pInt64s) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pInt64s) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pInt64s)  returned (*pArrLength)  returned (*pInt64s)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       int64s
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt64s/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH  Field type mismatch

MQERETURN mqeFields_getArrayOfInt16 MQeFieldsHndl    hFields,
MQeExceptBlock   pErrStruct,
MQEINT16 *    pInt16s,
MQEINT32 *    pArrLength,
MQECONST MQeStringHndl    hFieldName
 

This function gets a sequence of int16s hFieldName stored in hFields.

Parameters:
hFields  [in] MQeFields to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pInt16s  [in/out] Pointer to the result buffer
pArrLength  [in/out] Pointer to the length (number of elements) of (*pInt16s) array
hFieldName  [in] Handle for the name (as ASCII only characters in MQeString) of the array
Precondition:
hFields must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is NULL).
pArrLength must point to an existing MQEINT32.
hFieldName must point to an existing handle.
Returns :
(*pInt16s) and (*pArrLength):
 * ---------------------- ------------------- ----------------------- -------------------------
 * initial (*pArrLength)  initial (*pInt16s)  returned (*pArrLength)  returned (*pInt16s)
 * ---------------------- ------------------- ----------------------- -------------------------
 * <= 0                   any                 buffer sizes required   not defined 
 * any                    NULL                ditto                   ditto
 * > 0                    != NULL             buffer space used       int16s
 * 
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_SESSION_NOT_INITIALIZED 
  • MQeSession_initialize() not yet called
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_API_NULL_POINTER NULL hFields/pInt16s/pArrLength/hFieldName
  • MQEREASON_API_INVALID_SIGNATURE hFields not an MQeFields
MQERETURN_API_FIELD_TYPE_MISMATCH 
  • Field type mismatch


Generated Thu Aug 11 23:27:10 2005 for Websphere MQ Everyplace for Multiplatforms C Programming Reference