TipcMsgNextByte

Name

TipcMsgNextByte — get a BYTE field from a message

Synopsis

T_BOOL TipcMsgNextByte(msg, byte_return) 
T_IPC_MSG msg; 
T_UCHAR *byte_return;

Arguments

msg — message to get field from

byte_return — storage for BYTE value from field

Return Values

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

Diagnostics

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

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

TipcMsgNextByte retrieves the value of the current field of a message, which must be a BYTE field. If TipcMsgNextByte succeeds, it advances the current field to the next field in the message.

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

Caution

If TipcMsgNextByte returns FALSE, it does not store a value in byte_return.

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

Examples

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

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_UCHAR value; 
 
#define USER_MT_BTYE_TEST 100 
mt = TipcMtCreate("byte_test", USER_MT_BYTE_TEST, "byte"); 
if (mt == NULL) { 
    return;  /* error */ 
} 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
    return;  /* error */ 
} 
if (!TipcMsgAppendByte(msg, 'c')) { 
    return;  /* error */ 
} 
if (!TipcMsgSetCurrent(msg, 0)) { 
    return;  /* error */ 
} 
if (!TipcMsgNextByte(msg, &value)) { 
    return;  /* error */ 
} 
TutOut("byte value == %c\n", value);