TipcMonProjectNamesGetWatch

Name

TipcMonProjectNamesGetWatch — determine if this RTclient is watching project names

Synopsis

T_BOOL TipcMonProjectNamesGetWatch(watch_status_return) 
T_BOOL *watch_status_return;

Arguments

watch_status_return — storage for watch status

Return Values

TRUE if the project names watch status was successfully retrieved, FALSE otherwise.

Diagnostics

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

T_ERR_NULL_PTR — watch_status_return was null

Description

TipcMonProjectNamesGetWatch gets whether this RTclient is watching project names. The watch status controls whether the RTclient receives a MON_PROJECT_NAMES_STATUS message each time a project is created or destroyed. A project is considered created when the first RTclient in that project connects to RTserver. A project is considered destroyed when the last RTclient in that project disconnects from RTserver.

Each MON_PROJECT_NAMES_STATUS message contains three fields:

a STR_ARRAY field containing the current project names

a STR field containing the name of the created project (or "" if not applicable)

a STR field containing the name of the destroyed project (or "" if not applicable)

To set whether this RTclient is watching project names, use TipcMonProjectNamesSetWatch. To poll once for project names, use TipcMonProjectNamesPoll.

For an example of how MON_PROJECT_NAMES_STATUS messages can be used, see the RTmon GDI Project Browser window.

Caution

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

Examples

This example uses TipcMonProjectNamesGetWatch to get the status of watching project names:

T_BOOL watch_status; 
 
if (!TipcMonProjectNamesGetWatch(&watch_status)) { 
  return; /* error */ 
} 
TutOut("This RTclient is %s project names.\n", 
       watch_status ? "watching" : "not watching");