Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: edits/style


Scripting_function



Panel
titleDescription

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


Client permissions restrictions



Panel
titleSyntax

system.gui.getCurrentDesktop()

  • Parameters

NoneNothing

  • Returns

String  - The handle of the current desktop.

  • Scope

Vision Client



Panel
titleCode Examples


Code Block
languagepy
titleCode Snippet - 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())



Panel
titleKeywords

system gui getCurrentDesktop, gui.getCurrentDesktop