TipcMsgGetCurrentFieldKnown

Name

TipcMsgGetCurrentFieldKnown — checks if the current field in a message is of known value

Synopsis

T_BOOL TipcMsgGetCurrentFieldKnown(msg, field_valid_return) 
T_IPC_MSG msg; 
T_BOOL *field_valid_return;

Arguments

msg — message to get status of the current field from

field_valid_return — storage for status

Return Values

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

Diagnostics

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

T_ERR_NULL_PTR — msg was null or field_valid_return was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_MSG_EOM — the current field is past the last field of the message

Description

TipcMsgGetCurrentFieldKnown checks to see if the current field has a known value. A field_valid_return of TRUE indicates that the unknown_value property of the current field is not set and that the value of the field can be retrieved from the message. A field_valid_return of FALSE indicates that the unknown_value property of the current field is set, and that there is no value in the field that can be retrieved.

Caution

If TipcMsgGetCurrentFieldValid returns FALSE, it does not store a value in field_valid_return.

Examples

This example creates a message, appends a field and gets the status of the current field:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_REAL8 real8; 
T_BOOL field_valid;  
 
mt=TipcMtLookupByNum(T_MT_NUMERIC_DATA); 
if(mt==NULL) { 
  return;  /* error */ 
} 
 
msg=TipcMsgCreate(mt); 
if (msg==NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAppendStrReal8(msg,"speed limit", 65.0)) { 
  return;  /* error */ 
} 
 
if (!TipcMsgGetCurrentFieldKnown(msg, &field_valid)) { 
  return;  /* error */  
}