Get System Folder Path

Verb: getSpecialFolder

Available from: <Standard>

Gets the path to a selected system folder.

Syntax

getSpecialFolder --folder(Nullable<SpecialFolderWrapper>) (String)=value

Inputs

Script Designer Required AcceptedTypes Description
--folder Folder Required SpecialFolderWrapper Option to select the system folder of which the path should be gotten. The following options are available:
  • Admin Tools
  • Application Data
  • CD Burning
  • Common Admin Tools
  • Common Application Data
  • Common Desktop Directory
  • Common Documents
  • Common Music
  • Common OEM Links
  • Common Pictures
  • Common Program Files
  • Common Program Files (x86)
  • Common Programs
  • Common Start Menu
  • Common Startup
  • Common Templates
  • Common Videos
  • Cookies
  • Desktop
  • Desktop Directory
  • Favorites
  • Fonts
  • History
  • Internet Cache
  • Local Application Data
  • Localizes Resources
  • My Computer
  • My Documents
  • My Music
  • My Pictures
  • My Videos
  • Network Shortcuts
  • Printer Shortcuts
  • Program Files
  • Program Files (x86)
  • Programs
  • Recent
  • Resources
  • Send To
  • Start Menu
  • Startup
  • System
  • System (x86)
  • Templates
  • User Profile
  • Windows
  • Outputs

    Script Designer AcceptedTypes Description
    value Path Text Path to the selected folder.

    Example

    Gets the path to the desktop of the machine where the command is running.

    defVar --name path --type String
    getSpecialFolder --folder "Desktop" path=value
    // Display in console the path to the Desktop.
    logMessage --message "${path}" --type "Info"
    

    See Also

  • Check If Virtual Machine
  • Count Monitors
  • Get Display Devices
  • Get Screen Resolution
  • Lock the Machine
  • Logoff
  • Run
  • Set Screen Resolution
  • Shutdown