TipcMsgNextInt4

Name

TipcMsgNextInt4 — get an INT4 field from a message

Synopsis

T_BOOL TipcMsgNextInt4(msg, int4_return) 
T_IPC_MSG msg; 
T_INT4 *int4_return;

Arguments

msg — message to get field from

int4_return — storage for INT4 value from field

Return Values

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

Diagnostics

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

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

TipcMsgNextInt4 retrieves the value of the current field of a message, which must be an INT4 (four-byte integer) field. If TipcMsgNextInt4 succeeds, it advances the current field to the next field in the message.

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

Caution

If TipcMsgNextInt4 returns FALSE, it does not store a value in int4_return.

Examples

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

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_INT4 int4_val; 
 
#define USER_MT_INT4_TEST 100 
mt = TipcMtCreate("int4_test", USER_MT_INT4_TEST, "int4"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAppendInt4(msg, 42)) { 
  return;  /* error */ 
}  
if (!TipcMsgSetCurrent(msg, 0)) { 
  return;  /* error */ 
}  
if (!TipcMsgNextInt4(msg, &int4_val)) { 
  return;  /* error */ 
}  
TutOut("int4_val == %d\n", int4_val);