system.gui.getScreenIndex

note

This function was deprecated in 8.3 and replaced with a system.vision variation.

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.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

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