TipcMsgAddNamedBoolArray

Name

TipcMsgAddNamedBoolArray — add a field containing an array of BOOL fields to a message using a name, and a pointer to the field value, rather than a copy

Synopsis

T_BOOL TipcMsgAddNamedBoolArray(msg, name, size) 
T_IPC_MSG msg; 
T_STR name; 
T_INT4 size; 

Arguments

msg — message to add field to

name — name of the field

size — number of bytes in the field

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

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

Description

TipcMsgAddNamedBoolArray adds a BOOL_ARRAY 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

TipcMsgAppendBoolArray, TipcMsgUpdateNamedBoolArray, TipcMsgGetNamedBoolArray

Examples

This example creates a message and adds a BOOL_ARRAY value to it:

T_IPC_MSG msg; 
T_BOOL status; 
T_BOOL *array; 
T_INT4 array_size; 
 
msg = TipcMsgCreate(TipcMtLookupByNum(T_MT_INFO)); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
array_size = 2; 
array[0] = T_TRUE; 
array[1] = T_FALSE; 
 
status = TipcMsgAddNamedBoolArray(msg, "foo", array, array_size); 
if (status == FALSE) { 
  return;  /* error */ 
}