TipcMsgNextStrArray

Name

TipcMsgNextStrArray — get a field containing an array of STR fields from a message

Synopsis

T_BOOL TipcMsgNextStrArray(msg, str_array_return, array_size_return) 
T_IPC_MSG msg; 
T_STR **str_array_return; 
T_INT4 *array_size_return;

Arguments

msg — message to get field from

str_array_return — storage for STR_ARRAY value from field

array_size_return — storage for number of elements in array

Return Values

TRUE if the field was successfully retrieved from the message, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg was null, str_array_return was null, or array_size_return was null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_MSG_EOM — the current field is at the end of message

T_ERR_FT_MISMATCH — the current field is of the wrong type

T_ERR_VAL_UNKNOWN — the current field is of unknown value

Description

TipcMsgNextStrArray retrieves the value of the current field of a message, which must be a STR_ARRAY (array of null-terminated character strings) field. If TipcMsgNextStrArray succeeds, it advances the current field to the next field in the message.

TipcMsgNextStrArray converts the field into the data format used by this process, if necessary.

Caution

If TipcMsgNextStrArray returns FALSE, it does not store values in str_array_return and array_size_return.

Do not modify the value stored in str_array_return. It points directly into an internal data structure.

Examples

This example reads a STR_ARRAY field from a message and prints the values in the array:

T_STR *str_array; 
T_INT4 array_size; 
T_INT4 counter; 
 
if (!TipcMsgNextStrArray(msg, &str_array, &array_size)) { 
  return;  /* error */ 
}  
TutOut("array_size = %d\n", array_size); 
 
for (counter = 0; counter < array_size; counter++) { 
  TutOut("str_array[%d] = %s\n", counter, str_array[counter]); 
}