TipcMsgAddNamedByte

Name

TipcMsgAddNamedByte — add a BYTE field to a message using a name

Synopsis

T_BOOL TipcMsgAddNamedByte(msg, name, value) 
T_IPC_MSG msg; 
T_STR name; 
T_UCHAR value; 

Arguments

msg — message to add field to

name — name of the field

value — value of the field

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

If TipcMsgAddNamedByte fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMsgAddNamedByte adds a BYTE field to a message, associating that field with a name. If the name already exists in the message, this fails, and the field is not added to the message.

See Also

TipcMsgAppendByte, TipcMsgUpdateNamedByte, TipcMsgGetNamedByte

Examples

This example creates a message and adds a BYTE value to it using a pointer:

T_IPC_MSG msg; 
T_BOOL status; 
T_UCHAR data; 
 
msg = TipcMsgCreate(TipcMtLookupByNum(T_MT_INFO)); 
if (msg == NULL) { 
    return;  /* error */ 
} 
data = 0xFF; 
status = TipcMsgAddNamedByte(msg, "foo", data);