IsScreenOpen
The function IsScreenOpen that a project screen is open on a client.
| Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
|---|---|---|---|---|---|---|
| IsScreenOpen | Module Activity | Asynchronous | Supported | Supported | Supported | Not supported |
Syntax
IsScreenOpen(strScreen,optNumID)
- strScreen
- The name of the project screen to be verified.
- optNumID
- The specific ID number of the screen. (This number is assigned when the screen is opened using the function Open.)
This parameter is optional; if no value is specified, the default value is 0.
Returned value
This function returns the following possible values:
| Value | Description |
|---|---|
| 0 | Screen is not open. |
| 1 | Screen is open. |
Notes
If the option Enforce Web functionality equivalence is selected in the project settings, this function cannot be called from Global Procedures or Script worksheets. This is because the function is meaningful only when it is executed on stations that display project screens; it might cause unexpected behavior if it is called from background tasks that are executed on the project runtime server. For more information, see Preferences tab.
Examples
Is the screen named “main” open?
IsScreenOpen("main")
Is the screen named “main” with ID 10 open?
IsScreenOpen("main",10)