TipcMsgNextReal16Array

Name

TipcMsgNextReal16Array — get a field containing an array of REAL16 fields from a message

Synopsis

T_BOOL TipcMsgNextReal16Array(msg, real16_array_return, array_size_return) 
T_IPC_MSG msg; 
T_REAL16 **real16_array_return; 
T_INT4 *array_size_return;

Arguments

msg — message to get field from

real16_array_return — storage for REAL16_ARRAY value from field

array_size_return — storage for number of elements in array

Return Values

TRUE if the field was successfully retrieved from the message, FALSE otherwise.

Diagnostics

If TipcMsgNextReal16Array fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg was null, real16_array_return was null, or array_size_return was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_MSG_EOM — the current field is at the end of message

T_ERR_FT_MISMATCH — the current field is of the wrong type

T_ERR_VAL_UNKNOWN — the current field is of unknown value

Description

TipcMsgNextReal16Array retrieves the value of the current field of a message, which must be a REAL16_ARRAY (array of 16-byte real numbers) field. If TipcMsgNextReal16Array succeeds, it advances the current field to the next field in the message.

TipcMsgNextReal16Array converts the field into the data format used by this process if necessary.

Caution

If TipcMsgNextReal16Array returns FALSE, it does not store values in real16_array_return and array_size_return.

Do not modify the value stored in real16_array_return. It points directly into an internal data structure.


	Not all platforms fully support the REAL16 type. While some platforms can manipulate them as uninterpreted bytes, they can neither manipulate nor interpret them as numbers.

Examples

This example reads a REAL16_ARRAY field from a message and prints the values in the array:

T_REAL16 *real16_array; 
T_INT4 array_size; 
T_INT4 counter; 
 
if (!TipcMsgNextReal16Array(msg, &real16_array, &array_size)) { 
  return;  /* error */ 
}  
TutOut("array_size = %d\n", array_size); 
 
for (counter = 0; counter < array_size; counter++) { 
  TutOut("real16_array[%d] = " T_REAL16_SPEC "\n", counter, 
         real16_array[counter]); 
}