system.vision.getScreenIndex

Backwards Compatibility

This function replaces system.gui.getScreenIndex. 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

Returns an integer value representing the current screen index based on the screen from which this function was called.

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.getScreenIndex()

Parameters

Nothing

Returns

Integer - The screen from which the function was called.

Scope

Vision Client

Code Examples

Example #1

# Prints an integer representing the screen from which the function was called. 
print system.vision.getScreenIndex()