TipcSrvMonExtSetStr

Name

TipcSrvMonExtSetStr — add or update a field of type STR in an RTclient’s MON_CLIENT_EXT_POLL_RESULT message

Synopsis

T_BOOL TipcSrvMonExtSetStr(srv, field_name, data) 
T_IPC_SRV srv; 
T_STR field_name; 
T_STR data; 

Arguments

srv — connection handle to the RTserver

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.

Return Values

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

Diagnostics

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

Description

TipcSrvMonExtSetStr creates a field of type STR 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, TipcSrvMonExtSetStr only updates it with the value of data.

See Also

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

Examples

See the example for TipcSrvMonClientExtPoll.