TipcSrvMonSetIdentStr

Name

TipcSrvMonSetIdentStr — set the monitoring identification string of this process

Synopsis

T_BOOL TipcSrvMonSetIdentStr(srv, ident_str) 
T_IPC_SRV srv; 
T_STR ident_str; 

Arguments

srv — connection handle to RTserver

ident_str — identification string

Return Values

TRUE if the identification string was successfully set for this process, FALSE otherwise.

Diagnostics

If TipcSrvMonSetIdentStr fails, it returns FALSE and sets the global SmartSockets error number to:

Description

TipcSrvMonSetIdentStr sets the monitoring identification string for this process. This identification string is used as a descriptive name for the process when it is being monitored. See TipcSrvMonGetIdentStr for more information on monitoring identification strings.

Caution

Each RTclient sets the monitoring identification string in TipcSrvMonSetIdentStr. This string is stored in RTserver and is only sent to RTserver when RTclient connects to RTserver. A process that calls TipcSrvMonSetIdentStr after calling TipcSrvConnOpen will be identified incorrectly.

See Also

TipcSrvMonGetIdentStr

Examples

This example sets the monitoring identification string for this process to "Acme Inc. Custom RTclient":

if (!TipcSrvMonSetIdentStr(srv, "Acme Inc. Custom RTclient")) { 
  return;  /* error */ 
}