Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


New_in
Version7.9.2

 


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.


Panel
titleClient Permission Restrictions

This scripting function has no Client Permission restrictions.


Panel
titleSyntax

system.gui.getCurrentDesktop( )

  • Parameters

None

  • Returns

String  - The handle of the current desktop

  • Scope

Client



Panel
titleCode Examples


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