system.gui.getCurrentDesktop

Deprecated by system.vision variations in 8.3

This function was replaced with system.vision.getCurrentDesktop.

Click here to learn more about system.vision variations.

This function is used in Python Scripting.

Description

Returns the handle of the desktop this function was called from. Commonly used with the system.gui.desktop and system.nav.desktop functions.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.getCurrentDesktop( )

Parameters

Nothing

Returns

String - The handle of the current desktop.

Scope

Vision Client

Code Example

Getting a Desktop's Handle

# Shows the desktop's handle in a message box.
system.gui.messageBox("This desktop's handle is: %s" % system.gui.getCurrentDesktop())