TipcMsgAddNamedBinary

Name

TipcMsgAddNamedBinary — add a BINARY field to a message using a name

Synopsis

T_BOOL TipcMsgAddNamedBinary(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR value; 
T_INT4 size; 

Arguments

msg — message to add field to

name — name of the field

value — value of the field

size — size of the value, in bytes

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

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

Description

TipcMsgAddNamedBinary adds a BINARY 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

TipcMsgAppendBinary, TipcMsgUpdateNamedBinary, TipcMsgGetNamedBinary

Examples

This example creates a message and adds an existing BINARY value to it:

T_IPC_MSG msg; 
T_BOOL status; 
T_PTR bin_value; 
T_INT4 size; 
 
msg = TipcMsgCreate(TipcMtLookupByNum(T_MT_INFO)); 
if (msg == NULL) { 
  return;  /* error */ 
} 
status = TipcMsgAddNamedBinary(msg, "foo", bin_value, size); 
 
if (status == FALSE) { 
  return;  /* error */ 
}