TipcMsgNextStrReal8

T_BOOL TipcMsgNextStrReal8(msg, str_return, real8_return) 
T_IPC_MSG msg; 
T_STR *str_return; 
T_REAL8 *real8_return;

Arguments

Return Values

TRUE if the fields were successfully retrieved from the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null, str_return 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

TipcMsgNextStrReal8 is a convenience function that retrieves both a STR field and a REAL8 field from a message. TipcMsgNextStrReal8 is useful for accessing NUMERIC_DATA messages. The NUMERIC_DATA message type is often the most frequently used message type in SmartSockets.

TipcMsgNextStrReal8 converts the field into the data formats used by this process if necessary.

Caution

If TipcMsgNextStrReal8 returns FALSE, it does not store values in str_return and real8_return.

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

See Also

Examples

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

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_STR str_val; 
T_REAL8 real8_val; 
 
mt = TipcMtLookupByNum(T_MT_NUMERIC_DATA); 
if (mt == NULL) { 
  return;  /* error */ 
}  
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
}  
 
if (!TipcMsgAppendStrReal8(msg, "speed_limit", 55.0)) { 
  return;  /* error */ 
}  
if (!TipcMsgSetCurrent(msg, 0)) { 
  return;  /* error */ 
}  
if (!TipcMsgNextStrReal8(msg, &str_val, &real8_val)) { 
  return;  /* error */ 
}  
TutOut("str_val = %s, real8_val = %s\n", 
       str_val, TutRealToStr(real8_val));