Add Array

Convenience Functions

Declaration

tibrv_status
tibrvMsg_Addelement_typeArray(
   tibrvMsg            message,
   const char*         fieldName,
   const element_type*    value,
   tibrv_u32           numElements);
tibrv_status
tibrvMsg_Addelement_typeArrayEx(
   tibrvMsg             message,
   const char*          fieldName,
   const element_type*     value,
   tibrv_u32            numElements,
   tibrv_u16            fieldId);

Purpose

Add a field containing an array value.

Function Name	Element Type	Type Description
`tibrvMsg_AddF32Array`	`tibrv_f32`	32-bit floating point array
`tibrvMsg_AddF64Array`	`tibrv_f64`	64-bit floating point array
`tibrvMsg_AddI8Array`	`tibrv_i8`	8-bit integer array
`tibrvMsg_AddI16Array`	`tibrv_i16`	16-bit integer array
`tibrvMsg_AddI32Array`	`tibrv_i32`	32-bit integer array
`tibrvMsg_AddI64Array`	`tibrv_i64`	64-bit integer array
`tibrvMsg_AddU8Array`	`tibrv_u8`	8-bit unsigned integer array
`tibrvMsg_AddU16Array`	`tibrv_u16`	16-bit unsigned integer array
`tibrvMsg_AddU32Array`	`tibrv_u32`	32-bit unsigned integer array
`tibrvMsg_AddU64Array`	`tibrv_u64`	64-bit unsigned integer array
`tibrvMsg_AddMsgArray`	`tibrv_Msg`	message array
`tibrvMsg_AddStringArray`	`char*`	string array


Parameter	Description
`message`	Add the new field to this message.
`fieldName`	Create the new field with this name.
`value`	Add a new field that contains this array. The convenience function must correspond to the datatype of this value. The function copies the array into the new message field.
`numElements`	When adding an array type, the program supplies the count of array elements in this parameter.
`fieldId`	Create the new 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. It is illegal to add a field that has both a `NULL` field name, and a non-zero field identifier.

Did you find this helpful?

Yes No