system.vision.getOpenedWindows

Backwards Compatibility

This function replaces system.gui.getOpenedWindows. 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 all of the currently open windows and returns a tuple of references to them.

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.

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.

Syntax

system.vision.getOpenedWindows()

Parameters

Nothing

Returns

Tuple - A tuple of the opened windows, not their names, but the actual window objects themselves. Printing the return value will display results in the Vision Client console if not writing to a component property.

Scope

Vision Client

Code Examples

Example #1

# This example prints out the path of each currently opened window to the console.
  
windows = system.vision.getOpenedWindows()
print 'There are %d windows open' % len(windows)
for window in windows:
    print window.getPath()