system.vision.getCurrentDesktop

Backwards Compatibility

This function replaces system.gui.getCurrentDesktop. 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 the handle of the desktop this function was called from. Commonly used with the system.vision.desktop function.

note

If you have already created a reference to your desktop in a script, you can use the VisionUtilities wrapper class instance method getHandle() instead. Note that you may have to repeat the desktop handle when using this method.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.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.vision.showMessage("This desktop's handle is: %s" % system.vision.getCurrentDesktop())