Open topic with navigation

TIBCO Rendezvous® 8.7.0

# Get Array

Convenience Methods

## Declaration

    TibrvStatus getelement_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
`get` `F32Array` | `tibrv_``f32` | 32-bit floating point array
`get` `F64Array` | `tibrv_``f64` | 64-bit floating point array
`get` `I8Array` | `tibrv_``i8` | 8-bit integer array
`get` `I16Array` | `tibrv_``i16` | 16-bit integer array
`get` `I32Array` | `tibrv_``i32` | 32-bit integer array
`get` `I64Array` | `tibrv_``i64` | 64-bit integer array
`get` `U8Array` | `tibrv_``u8` | 8-bit unsigned integer array
`get` `U16Array` | `tibrv_``u16` | 16-bit unsigned integer array
`get` `U32Array` | `tibrv_``u32` | 32-bit unsigned integer array
`get` `U64Array` | `tibrv_``u64` | 64-bit unsigned integer array

Parameter | Description
`fieldName` | Get a field with this name.
`value` | 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.
`numElementsAddr` | 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.
`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.

## See Also

Validity of Data Extracted From Message Fields

Field Names and Field Identifiers

Did you find this helpful?

Yes No
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO Rendezvous®

Copyright © 1997-2023. Cloud Software Group, Inc. All Rights Reserved.