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

This scripting function has no Client Permission restrictions.

system.gui.getCurrentDesktop( )

  • Parameters


  • Returns

String  - The handle of the current desktop

  • Scope


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