TipcMsgNextReal8

Name

TipcMsgNextReal8 — get a REAL8 field from a message

Synopsis

T_BOOL TipcMsgNextReal8(msg, real8_return) 
T_IPC_MSG msg; 
T_REAL8 *real8_return;

Arguments

msg — message to get field from

real8_return — storage for REAL8 value from field

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — msg was null or real8_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

TipcMsgNextReal8 retrieves the value of the current field of a message, which must be a REAL8 (eight-byte real number) field. If TipcMsgNextReal8 succeeds, it advances the current field to the next field in the message.

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

Caution

If TipcMsgNextReal8 returns FALSE, it does not store a value in real8_return.

Examples

This example creates a message, appends a REAL8 field, and reads the field back from the message:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_REAL8 real8_val; 
 
#define USER_MT_REAL8_TEST 100 
mt = TipcMtCreate("real8_test", USER_MT_REAL8_TEST, "real8"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAppendReal8(msg, 42.0)) { 
  return;  /* error */ 
}  
if (!TipcMsgSetCurrent(msg, 0)) { 
  return;  /* error */ 
}  
if (!TipcMsgNextReal8(msg, &real8_val)) { 
  return;  /* error */ 
}  
TutOut("real8_val = %s\n", TutRealToStr(real8_val));