TipcMsgAppendStrArray

TipcMsgAppendStrArray — append a field containing an array of STR fields to a message

Synopsis

T_BOOL TipcMsgAppendStrArray(msg, str_array_data, array_size) 
T_IPC_MSG msg; 
T_STR *str_array_data; 
T_INT4 array_size;

Arguments

Return Values

TRUE if the field was successfully appended to the message, FALSE otherwise.

Diagnostics

If TipcMsgAppendStrArray fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — msg was null or str_array_data was null

T_ERR_READ_ONLY — the message was marked read-only. This happens if the message is a field in another message.

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_VAL_TOO_SMALL — array_size was negative

Description

TipcMsgAppendStrArray appends a string array (STR_ARRAY) field containing str_array_data to the end of a message’s data. TipcMsgAppendStrArray makes a copy of the string array data.

Caution

See Also

Examples

T_IPC_MT mt; 
T_IPC_MSG msg; 
T_STR data[2]; 
 
#define USER_MT_STR_ARRAY_TEST 100 
mt = TipcMtCreate("str_array_test", USER_MT_STR_ARRAY_TEST,  
                  "str_array"); 
if (mt == NULL) { 
  return;  /* error */ 
} 
 
msg = TipcMsgCreate(mt); 
if (msg == NULL) { 
  return;  /* error */ 
} 
 
/* An RTclient would typically set the destination of */ 
/* a message at this point by calling TipcMsgSetDest. */ 
 
data[0] = "Hello"; 
data[1] = "world"; 
if (!TipcMsgAppendStrArray(msg, data, 2)) { 
  return;  /* error */ 
}  
 
/* A process would typically send a message at this point by */ 
/* calling TipcConnMsgSend or TipcSrvMsgSend. */ 
 
/* A process would typically destroy a message at this point by */ 
/* calling TipcMsgDestroy. */