Open topic with navigation

TIBCO Rendezvous® 8.7.0

# Get Scalar

Convenience Functions

## Declaration

    tibrv_status
    tibrvMsg_Getscalar_type(
       tibrvMsg       message,
       const char*    fieldName,
       scalar_type*    value);
    tibrv_status
    tibrvMsg_Getscalar_typeEx(
       tibrvMsg       message,
       const char*    fieldName,
       scalar_type*    value,
       tibrv_u16      fieldId);

## Purpose

Get the value of a field as a scalar value.

## Remarks

Each convenience function in this family retrieves a field and extracts its data. If the field’s type (as it exists) 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.

Function Name | Type | Type Description
`tibrvMsg_Get` `Bool` | `tibrv_``bool` | boolean
`tibrvMsg_Get` `F32` | `tibrv_``f32` | 32-bit floating point
`tibrvMsg_Get` `F64` | `tibrv_``f64` | 64-bit floating point
`tibrvMsg_Get` `I8` | `tibrv_``i8` | 8-bit integer
`tibrvMsg_Get` `I16` | `tibrv_``i16` | 16-bit integer
`tibrvMsg_Get` `I32` | `tibrv_``i32` | 32-bit integer
`tibrvMsg_Get` `I64` | `tibrv_``i64` | 64-bit integer
`tibrvMsg_Get` `U8` | `tibrv_``u8` | 8-bit unsigned integer
`tibrvMsg_Get` `U16` | `tibrv_``u16` | 16-bit unsigned integer
`tibrvMsg_Get` `U32` | `tibrv_``u32` | 32-bit unsigned integer
`tibrvMsg_Get` `U64` | `tibrv_``u64` | 64-bit unsigned integer
`tibrvMsg_Get` `IPAddr32` | `tibrv_``ipaddr32` | 4-byte IP address
`tibrvMsg_Get` `IPPort16` | `tibrv_``ipport16` | 2-byte IP port

Parameter | Description
`message` | Get the specified field of this message.
`fieldName` | Get a field with this name.
`value` | When extracting a scalar type, the program supplies a location in this parameter, and the function copies the scalar value of the field to 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.

## See Also

Validity of Data Extracted From Messages

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.