system.gui.findWindow

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.gui.openWindowInstance.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.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

Client

Code Examples

Example #1

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