TipcSrvMonGetIdentStr

Name

TipcSrvMonGetIdentStr — retrieve the monitoring identification string of this process

Synopsis

T_BOOL TipcSrvMonGetIdentStr(srv, ident_str_return) 
T_IPC_SRV srv; 
T_STR *ident_str_return; 

Arguments

srv — connection handle to RTserver

ident_str_return — storage for identification string

Return Values

TRUE if the identification string was successfully retrieved, FALSE otherwise.

Diagnostics

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

Description

TipcSrvMonGetIdentStr gets the monitoring identification string of this process. This identification string is used as a descriptive name for the process when it is being monitored. It is used as part of a field in these message types:

In these message types, the full field has the form "ident: user@node" (for example, "Primary_RTclient: ssuser@workstation1". The monitoring identification string is used as ident. By default the monitoring identification string is based on the most descriptive counted license the process has (for example, Primary_RTclient is more descriptive than RTclient). This string can be set with the function TipcSrvMonSetIdentStr.

Caution

The storage pointed to by ident_str_return should not be modified or freed. The storage is thread safe, but may be overwritten by subsequent calls to SmartSockets APIs within the same thread. If you wish to preserve the value, you should make a copy of the value.

See Also

TipcSrvMonSetIdentStr

Examples

This example gets and prints the monitoring identification string for this process:

T_STR ident_str; 
 
if (!TipcSrvMonGetIdentStr(srv, &ident_str)) { 
  return;  /* error */ 
} 
TutOut("Monitoring identification string is %s\n", ident_str);