TipcMsgNextInt8

Name

TipcMsgNextInt8 — get an INT8 field from a message

Synopsis

T_BOOL TipcMsgNextInt8(msg, int8_return) 
T_IPC_MSG msg; 
T_INT8 *int8_return;

Arguments

msg — message to get field from

int8_return — storage for INT8 value from field

Return Values

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

Diagnostics

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

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

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

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

Caution

If TipcMsgNextInt8 returns FALSE, it does not store a value in int8_return.

Eight-byte integers are not available as native integer data types on all platforms.

Examples

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

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_INT8 int8_val; 
 
#define USER_MT_INT8_TEST 100 
mt = TipcMtCreate("int8_test", USER_MT_INT8_TEST, "int8"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAppendInt8(msg, 82000000000)) { 
  return;  /* error */ 
}  
if (!TipcMsgSetCurrent(msg, 0)) { 
  return;  /* error */ 
}  
if (!TipcMsgNextInt8(msg, &int8_val)) { 
  return;  /* error */ 
}  
TutOut("int8_val == " T_INT8_SPEC "\n", int8_val);