Base APIs

Table 2 lists the core MQeFields APIs.

Table 2. MQeFields base API

API Description
MQeFieldsAlloc() Allocate a new MQeFields object and returns a handle to it.
MQeFieldsDelete() Delete an existing field in the MQeFields object.
MQeFieldsDump() Serialize the internal name/value pair fields into a byte array for storage or communication.
MQeFieldsDumpLength() Get the total number of bytes needed to hold the serialized fields in the MQeFields object.
MQeFieldsEquals() Compare two MQeFields object and determines if they are the same.
MQeFieldsFields() Return the number of fields in the MQeFields object.
MQeFieldsFree() Deallocate an MQeFields object and recovers its resources.
MQeFieldsGet() Given a field name, return the field.
MQeFieldsGetArray() Given a name, returns an array from fields generated by the name.
MQeFieldsGetByArrayOfFd() Get an array of fields.
MQeFieldsGetByIndex() Given an index, return the field at the index.
MQeFieldsGetByStruct() Given a data structure and its fields structure descriptor, populate the data structure with the fields.
MQeFieldsHide() Exclude a field from an MQeFields comparison API, MQeFieldsEquals()
MQeFieldsPut() Put a field into an MQeFields object.
MQeFieldsPutArray() Given a name, put an array as fields generated by the name.
MQeFieldsPutByArrayOfFd() Given an array of field descriptors and associated field data, put them into the fields.
MQeFieldsPutByStruct() Given a data structure and its fields structure descriptor, create the fields.
MQeFieldsRead() Read from a field as an output stream.
MQeFieldsRestore() Resolve a byte array into name/value pair fields and store them in an MQeFields object.
MQeFieldsType() Extract the object type of an MQeFields object.
MQeFieldsWrite() Write to a field as an input stream.



© IBM Corporation 2002. All Rights Reserved