system.vision.findWindow

Backwards Compatibility

This function replaces system.gui.findWindow. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Finds and returns a list of windows with the given path. If the window is not open, an empty list will be returned. Useful for finding all instances of an open window that were opened with system.vision.openWindowInstance.

note

This function is available on secondary desktops via the system.vision.desktop function. See the Multi-Monitor Clients page for more details on secondary desktops.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.findWindow(path)

Parameters

Type	Parameter	Description
String	path	The path of the window to search for.

Returns

List - A list of window objects. May be empty if window is not open, or have more than one entry if multiple windows are open.

Scope

Vision Client

Code Examples

Example #1 - Finding a Window and Closing It

# This example finds all open instances of the window named "Popup" and closes them all.
  
allInstances = system.vision.findWindow("Popup")
for window in allInstances:
    system.vision.closeWindow(window)