system.vision.closeDesktop

Backwards Compatibility

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

Allows you to close any of the open desktops associated with the current client. See the Multi-Monitor Clients page for more details about using multiple monitors.

note

If you have already created a reference to your desktop in a script, you can use the VisionUtilities wrapper class instance method close() 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.closeDesktop(handle)

Parameters

Type	Parameter	Description
String	handle	The handle for the desktop to close. The screen index cast as a string may be used instead of the handle. If omitted, this will default to the primary desktop. Alternatively, the handle "primary" can be used to refer to the primary desktop.

Returns

Nothing

Scope

Vision Client

Code Examples

Example #1

# The following example will close this desktop
system.vision.closeDesktop()

Example #2

# The following example will close desktop 2
# The handle must be a string
system.vision.closeDesktop("2")

Example #3

# The following example will close the desktop named "Left Monitor"
system.vision.closeDesktop("Left Monitor")