AppIsRunning
AppIsRunning is a built-in scripting function that verifies another application window is open and running.
Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
---|---|---|---|---|---|---|
AppIsRunning | Module Activity | Synchronous | Supported | Supported | Supported | Not supported |
Syntax
- strAppTitle
- The full title (as shown in the title bar) of the application window.
- optNumTimeout
- The timeout period (in milliseconds) for the function to be successfully executed. If, for whatever reason, the function is not executed in this period, then it is aborted.
This is an optional parameter. If no value is specified, then the default timeout is five seconds (or 5000 milliseconds).
Returned value
This function will return one of the following values:
Value | Description |
---|---|
0 | ERROR: The specified application window is not open or otherwise did not respond within the timeout period. |
1 | SUCCESS: The specified application window is open and running. |
Notes
AppIsRunning is similar to the function IsWindow in the Microsoft Windows API. For more information, please refer to the Windows API documentation.
Examples
Verify the Microsoft Word document named test.doc is open and running:
AppIsRunning( "test.doc — Microsoft Word" )