TipcMsgAddNamedUtf8Array

Name

TipcMsgAddNamedUtf8Array — add a field containing an array of UTF8 fields to a message using a name

Synopsis

T_BOOL TipcMsgAddNamedUtf8Array(msg, name, value, size) 
T_IPC_MSG msg; 
T_STR name; 
T_STR *value; 
T_INT4 size; 

Arguments

msg — message to add field to

name — name of the field

value — value of the field

size — number of elements in the field

Return Values

TRUE if the addition was successful, FALSE otherwise.

Diagnostics

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

Description

TipcMsgAddNamedUtf8Array adds a field containing an array of UTF8 fields 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

TipcMsgAppendUtf8Array, TipcMsgUpdateNamedUtf8Array, TipcMsgGetNamedUtf8Array

Examples

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

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