TipcMonClientTimeGetWatch

Name

TipcMonClientTimeGetWatch — determine if this RTclient is watching time information in an RTclient

Synopsis

T_BOOL TipcMonClientTimeGetWatch(client_name, watch_status_return) 
T_STR client_name; 
T_BOOL *watch_status_return; 

Arguments

client_name — name of RTclient to get watch status for (wildcard names allowed, or use T_IPC_MON_ALL to indicate a watch of all RTclients matching the value of Monitor_Scope)

watch_status_return — storage for watch status

Return Values

TRUE if the RTclient time information watch status was successfully retrieved, FALSE otherwise.

Diagnostics

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

Description

TipcMonClientTimeGetWatch gets whether this RTclient is watching time information in the client_name RTclient. The client_name argument can be the unique subject name of a single RTclient, a wildcarded subject name to match many RTclients, or T_IPC_MON_ALL to watch all RTclients in the project that match the value of the Monitor_Scope option. The watch status controls whether the RTclient receives a MON_CLIENT_TIME_STATUS message each time the current time changes in the watched RTclient.

Each MON_CLIENT_TIME_STATUS message contains seven fields:

To set whether this RTclient is watching RTclient time information, use TipcMonClientTimeSetWatch. To poll once for RTclient time information, use TipcMonClientTimePoll.

For an example of how MON_CLIENT_TIME_STATUS messages can be used, see the RTmon GDI Watch Client Time window.

Caution

If TipcMonClientTimeGetWatch returns FALSE, it does not store a value in watch_status_return.

See Also

TipcMonClientTimePoll, TipcMonClientTimeSetWatch

Examples

This example uses TipcMonClientTimeGetWatch to get the status of watching time information in the primary RTclient:

T_BOOL watch_status; 
 
if (!TipcMonClientTimeGetWatch("primary", &watch_status)) { 
  return; /* error */ 
} 
TutOut("This process is %s time information in primary.\n", 
       watch_status ? "watching" : "not watching");