Update Array

Convenience Methods

Declaration

TibrvStatus updateelement_typeArray(
    const char*               fieldName,
    const tibrv_scalar_type    value,
    tibrv_u32                 numElements,
    tibrv_u16                 fieldId=0);

Purpose

Update a field containing an array value.

Remarks

Each convenience method in this family locates a field (by name or identifier) and updates its data.

The type of the existing field (within the message) and the type of the updating value must match. The number of elements can change.

Pointer data previously extracted from the field remain valid and unchanged until the message is destroyed; that is, even updating the field’s value does not invalidate pointer data. (See Pointer Snapshot.)

Method Name

Element Type

Type Description

updateI8Array

tibrv_i8

8-bit integer array

updateU8Array

tibrv_u8

8-bit unsigned integer array

updateI16Array

tibrv_i16

16-bit integer array

updateU16Array

tibrv_u16

16-bit unsigned integer array

updateI32Array

tibrv_i32

32-bit integer array

updateU32Array

tibrv_u32

32-bit unsigned integer array

updateI64Array

tibrv_i64

64-bit integer array

updateU64Array

tibrv_u64

64-bit unsigned integer array

updateF32Array

tibrv_f32

32-bit floating point array

updateF64Array

tibrv_f64

64-bit floating point array

Parameter

Description

fieldName

Update a field with this name.

value

Update the message field to this array value.

The method copies the new array into the existing field.

numElements

When updating an array type, the program supplies the count of array elements in this parameter.

fieldId

Update the field with this identifier. Zero is a special value that signifies no field identifier. It is illegal to add a field that has both a NULL field name, and a non-zero field identifier.

See Also

Field Names and Field Identifiers