TipcMsgUpdateNamedUtf8ArrayPtr

Name

TipcMsgUpdateNamedUtf8ArrayPtr — update a named pointer to a field containing an array of UTF8 fields in a message

Synopsis

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

Arguments

msg — message to update field in

name — name of the field

value — new 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 update was successful, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — msg, name or value is null

T_ERR_MSG_INVALID — msg was not a valid message

T_ERR_FT_MISMATCH — the message type grammar did not match the fields in the message

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

T_ERR_VALUE_INVALID — value was not a valid value

Description

TipcMsgUpdateNamedUtf8ArrayPtr updates a UTF8_ARRAY pointer field specified by field name.

Examples

This example changes the value of the named field "data":

T_STR *data; 
T_INT4 size; 
if (!TipcMsgUpdateNamedUtf8ArrayPtr(msg, "data", data, size, 
T_NULL)) { 
  return;  /* error */ 
}