Get Array
Convenience Methods
Declaration
TibrvStatusgetelement_typeArray(
const char* fieldName,
tibrv_element_type*& value,
tibrv_u32& numElementsAddr,
tibrv_u16 fieldId=0);
Purpose
Get the value of a field as an array.
Remarks
Each convenience method in this family retrieves a field and extracts its data. If the field’s type (as it exists) is does not match the type of the convenience method, then the method attempts to convert the data (see Datatype Conversion). If conversion is not possible, the method returns TIBRV_CONVERSION_FAILED.
Pointer data extracted from the field remain valid until the message is destroyed; that is, even removing the field or updating the field’s value does not invalidate pointer data.
These methods produce values that are read-only snapshots of the field data (see Pointer Snapshot). Programs must not modify elements of the value array.
|
Method Name |
Element Type |
Type Description |
|
|
|
32-bit floating point array |
|
|
|
64-bit floating point array |
|
|
|
8-bit integer array |
|
|
|
16-bit integer array |
|
|
|
32-bit integer array |
|
|
|
64-bit integer array |
|
|
|
8-bit unsigned integer array |
|
|
|
16-bit unsigned integer array |
|
|
|
32-bit unsigned integer array |
|
|
|
64-bit unsigned integer array |
|
Parameter |
Description |
|
|
Get a field with this name. |
|
|
When extracting an array type, the program supplies a variable in this parameter, and the method stores a pointer to the array in that variable. |
|
|
When extracting an array type, the program supplies a variable in this parameter, and the method stores the number of array elements in that variable. |
|
|
Get the field with this identifier. Zero is a special value that signifies no field identifier. All non-zero field identifiers must be unique within each message. |