TipcMsgAddNamedInt2ArrayPtr

Name

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

Synopsis

T_BOOL TipcMsgAddNamedInt2ArrayPtr(msg, name, value, size, field_return) 
T_IPC_MSG msg; 
T_STR name; 
T_INT2 *value; 
T_INT4 size; 
T_IPC_MSG_FIELD *field_return; 

Arguments

msg — message to add field to

name — name of the field

value — value of the field

size — number of elements 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 TipcMsgAddNamedInt2ArrayPtr fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcMsgAddNamedInt2ArrayPtr adds a field containing an array of INT2 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. 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

TipcMsgAppendInt2ArrayPtr, TipcMsgUpdateNamedInt2ArrayPtr, TipcMsgFieldUpdateInt2ArrayPtr

Examples

This example creates a message and adds a pointer to an INT2_ARRAY value to it:

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_INT2 data[10]; 
T_IPC_MSG_FIELD field; 
 
#define USER_MT_INT2_ARRAY_TEST 100 
mt = TipcMtCreate("int2_array_test", USER_MT_INT2_ARRAY_TEST, 
                  "int2_array"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
if (!TipcMsgAddNamedInt2ArrayPtr(msg, "named_int2_array", data, 0, 
                                 &field)) { 
  return;  /* error */ 
} 
 
data[0] = 56; 
data[1] = 57; 
if (!TipcMsgFieldSetSize(field, 2)) { 
  return;  /* error */ 
}