Get Array

Convenience Functions

Declaration

tibrv_status tibrvMsg_Getelement_typeArray(
   tibrvMsg       message,
   const char*    fieldName,
   element_type**    value,
   tibrv_u32*     numElementsAddr)
tibrv_status tibrvMsg_Getelement_typeArrayEx(
   tibrvMsg       message,
   const char*    fieldName,
   element_type**    value,
   tibrv_u32*     numElementsAddr,
   tibrv_u16      fieldId);

Purpose

Get the value of a field as an array.

Remarks

Each convenience function 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 function, then the function attempts to convert the data (see Datatype Conversion). If conversion is not possible, the function 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 functions produce values that are read-only snapshots of the field data (see Pointer Snapshot). Programs must not modify elements of the value array.


Function Name	Element Type	Type Description
`tibrvMsg_GetF32Array`	`tibrv_f32`	32-bit floating point array
`tibrvMsg_GetF64Array`	`tibrv_i64`	64-bit floating point array
`tibrvMsg_GetI8Array`	`tibrv_i8`	8-bit integer array
`tibrvMsg_GetI16Array`	`tibrv_i16`	16-bit integer array
`tibrvMsg_GetI32Array`	`tibrv_i32`	32-bit integer array
`tibrvMsg_GetI64Array`	`tibrv_i64`	64-bit integer array
`tibrvMsg_GetU8Array`	`tibrv_u8`	8-bit unsigned integer array
`tibrvMsg_GetU16Array`	`tibrv_u16`	16-bit unsigned integer array
`tibrvMsg_GetU32Array`	`tibrv_u32`	32-bit unsigned integer array
`tibrvMsg_GetU64Array`	`tibrv_u64`	64-bit unsigned integer array
`tibrvMsg_GetMsgArray`	`tibrv_Msg`	message array
`tibrvMsg_GetStringArray`	`char*`	string array

Parameter	Description
`message`	Get the specified field of this message.
`fieldName`	Get a field with this name.
`value`	When extracting an array type, the program supplies a location in this parameter, and the function stores a pointer to the array in that location.
`numElementsAddr`	When extracting an array type, the program supplies a location in this parameter, and the function stores the number of array elements in that location.
`fieldId`	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.

Get Array

Declaration

Purpose

Remarks

See Also