Update Scalar

Convenience Functions

Declaration

tibrv_status tibrvMsg_Updatescalar_type(
   tibrvMsg       message,
   const char*    fieldName,
   scalar_type     value);
tibrv_status tibrvMsg_Updatescalar_typeEx(
   tibrvMsg       message,
   const char*    fieldName,
   scalar_type     value,
    tibrv_u16     fieldId);

Purpose

Update a field containing a scalar value.

Remarks

Each convenience function 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.

Function Name

Value Type

Type Description

tibrvMsg_UpdateBool

tibrv_bool

boolean scalar

tibrvMsg_UpdateI8

tibrv_i8

8-bit integer

tibrvMsg_UpdateU8

tibrv_u8

8-bit unsigned integer

tibrvMsg_UpdateI16

tibrv_i16

16-bit integer

tibrvMsg_UpdateU16

tibrv_u16

16-bit unsigned integer

tibrvMsg_UpdateI32

tibrv_i32

32-bit integer

tibrvMsg_UpdateU32

tibrv_u32

32-bit unsigned integer

tibrvMsg_UpdateI64

tibrv_i64

64-bit integer

tibrvMsg_UpdateU64

tibrv_u64

64-bit unsigned integer

tibrvMsg_UpdateF32

tibrv_f32

32-bit floating point

tibrvMsg_UpdateF64

tibrv_f64

64-bit floating point

tibrvMsg_UpdateIPAddr32

tibrv_ipaddr32

4-byte IP address

tibrvMsg_UpdateIPPort16

tibrv_ipport16

2-byte IP port

Parameter

Description

message

Update the specified field of this message.

fieldName

Update a field with this name.

value

Update the message field to this value (which may be a literal or stored in a variable).

The function copies the value into the new message field.

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