TipcMonSetIdentStr

Name

TipcMonSetIdentStr — set the monitoring identification string of this process

Synopsis

T_BOOL TipcMonSetIdentStr(ident_str) 
T_STR ident_str; 

Arguments

ident_str — identification string

Return Values

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

Diagnostics

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

Description

TipcMonSetIdentStr 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 TipcMonGetIdentStr for more information on monitoring identification strings.

The identification string can also be set with the Monitor_Ident option. See the TIBCO SmartSockets User’s Guide for more information.

Caution

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

See Also

TipcMonGetIdentStr

Examples

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

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