TipcMsgAppendReal16Array

Name

TipcMsgAppendReal16Array — append a field containing an array of REAL16 fields to a message

Synopsis

T_BOOL TipcMsgAppendReal16Array(msg, real16_array_data, array_size) 
T_IPC_MSG msg; 
T_REAL16 *real16_array_data; 
T_INT4 array_size;

Arguments

msg — message to append field to

real16_array_data — data for new message field

array_size — number of elements in real16_array_data

Return Values

TRUE if the field was successfully appended to the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null or real16_array_data was null

T_ERR_READ_ONLY — the message was marked read-only. This happens if the message is a field in another message.

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_VAL_TOO_SMALL — array_size was negative

Description

TipcMsgAppendReal16Array appends a 16-byte real number array (REAL16_ARRAY) field containing real16_array_data to the end of a message’s data. TipcMsgAppendReal16Array makes a copy of the array data.


	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 creates a message and appends a REAL16_ARRAY field:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_REAL16 data[2]; 
 
#define USER_MT_REAL16_ARRAY_TEST 100 
mt = TipcMtCreate("real16_array_test", USER_MT_REAL16_ARRAY_TEST,  
                  "real16_array"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
/* An RTclient would typically set the destination of */ 
/* a message at this point by calling TipcMsgSetDest. */ 
 
data[0] = 1e1000; 
data[1] = 2e1000; 
if (!TipcMsgAppendReal16Array(msg, data, 2)) { 
  return;  /* error */ 
}  
 
/* A process would typically send a message at this point by */ 
/* calling TipcConnMsgSend or TipcSrvMsgSend. */ 
 
/* A process would typically destroy a message at this point by */ 
/* calling TipcMsgDestroy. */