TipcMsgAddNamedBoolArrayPtr

Name

TipcMsgAddNamedBoolArrayPtr — 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 TipcMsgAddNamedBoolArrayPtr(msg, name, ptr, size, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_PTR ptr; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return; 

Arguments

msg — message to add field to

name — name of the field

ptr — pointer to the value of the field

size — number of bytes in the field

field_return — optional value to return field (use NULL if not needed)

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

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

Description

TipcMsgAddNamedBoolArrayPtr 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. The value given is used as a pointer to the value, so the copy is made when the message is actually sent, not when the call is made. You must ensure that the data pointed to remains valid until the message is sent.

See Also

TipcMsgAppendBoolArrayPtr, TipcMsgUpdateNamedBoolArrayPtr, TipcMsgFieldUpdateBoolArrayPtr

Examples

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

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_BOOL data[10]; 
T_IPC_MSG_FIELD field; 
 
#define USER_MT_BOOL_ARRAY_TEST 100 
mt = TipcMtCreate("bool_array_test", USER_MT_BOOL_ARRAY_TEST, 
                  "bool_array"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAddNamedBoolArrayPtr(msg, "named_bool_array", data, 0, 
&field)) { 
  return;  /* error */ 
} 
 
data[0] = T_TRUE; 
data[1] = T_FALSE; 
if (!TipcMsgFieldSetSize(field, 2)) { 
  return;  /* error */ 
}