TipcMonExtSetUtf8Array

Name

TipcMonExtSetUtf8Array — add or update a field containing an array of type UTF8 in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

Synopsis

T_BOOL TipcMonExtSetUtf8Array(field_name, data, size) 
T_STR field_name; 
T_STR *data; 
T_INT4 size; 

Arguments

field_name — name of a field in the RTclient’s MON_CLIENT_EXT_POLL_RESULT message.

data — the RTclient information to write to field_name in the MON_CLIENT_EXT_POLL_RESULT message.

size — number of elements in the field.

Return Values

TRUE if the field was added or updated, FALSE otherwise.

Diagnostics

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

Description

TipcMonExtSetUtf8Array creates a field containing an array of type UTF8 in the RTclient’s MON_CLIENT_EXT_POLL_RESULT message to associate with one of the RTclient’s fields. If the field in the MON_CLIENT_EXT_POLL_RESULT message does not exist, it is created and updated with the value of data. If the field already exists in the MON_CLIENT_EXT_POLL_RESULT message, TipcMonExtSetUtf8Array only updates it with the value of data.

See Also

Use other TipcMonExt* APIs as necessary to define extension data in each RTclient that is polled by TipcMonClientExtPoll.

Examples

See the example for TipcMonClientExtPoll.