System special folder path (includes My Documents, My Music, Program Files, Desktop, and more).

Platforms Supported: All

See also ${processdir} , ${basedir} , ${currentdir} , ${tempdir}

${specialfolder:dir=String:file=String:folder=Enum}

Example using CommonApplicationData which is good when running as Windows Service:

• fileName="${specialfolder:folder=CommonApplicationData:cached=true}/AppName/logfile.txt"
  • Windows-Path - C:/ProgramData/AppName/logfile.txt

• dir - Name of the directory to be Path.Combine()'d with the directory name.
• file - Name of the file to be Path.Combine()'d with the directory name.

• folder - System special folder to use. Full list of options is available at MSDN. The most common ones are:

  • ApplicationData - Roaming application data for current user
    • Windows Path = C:\Users\%USERNAME%\AppData\Roaming
    • Xamarin Mono = $HOME/.config (or $XDG_CONFIG_HOME if set)
    • Xamarin iOS = /data/Containers/Data/Application/@GENERATED_NAME@/Documents/.config
    • Xamarin Android = /data/data/@PACKAGE_NAME@/files/.config
  • LocalApplicationData - Non roaming application data for current user
    • Windows Path = C:\Users\%USERNAME%\AppData\Local
    • Xamarin Mono = $HOME/.local/share (or $XDG_DATA_HOME if set)
    • Xamarin iOS = /data/Containers/Data/Application/@GENERATED_NAME@/Documents
    • Xamarin Android = /data/data/@PACKAGE_NAME@/files/.local/share
  • CommonApplicationData - Application data for all users (Good when running as Windows Service)
    • Windows Path = C:\ProgramData
    • Xamarin Mono = /usr/share
    • Xamarin iOS = /usr/share
    • Xamarin Android = /usr/share
  • MyDocuments - My Documents
    • Windows Path = C:\Users\%USERNAME%\Documents
    • Xamarin Mono = $HOME
    • Xamarin iOS = /data/Containers/Data/Application/@GENERATED_NAME@/Documents
    • Xamarin Android = /data/data/@PACKAGE_NAME@/files
  • Desktop - My Desktop
    • Windows Path = C:\Users\%USERNAME%\Desktop
    • Xamarin Mono = $HOME/Desktop (or $XDG_DESKTOP_DIR if set)
    • Xamarin iOS = /data/Containers/Data/Application/@GENERATED_NAME@/Documents/Desktop
    • Xamarin Android = /data/data/@PACKAGE_NAME@/files/Desktop
  • UserProfile
    • Windows Path = C:\Users\%USERNAME%
    • Xamarin Mono = $HOME
    • Xamarin iOS = /data/Containers/Data/Application/@GENERATED_NAME@
    • Xamarin Android = /data/data/@PACKAGE_NAME@/files
  • Templates
    • Windows Path = C:\Users\%USERNAME%\AppData\Roaming\Microsoft\Windows\Templates
    • Xamarin Mono = $HOME/Templates (or $XDG_TEMPLATES_DIR if set)
    • Xamarin iOS = /data/Containers/Data/Application/@GENERATED_NAME@/Documents/Templates
    • Xamarin Android = /data/data/@PACKAGE_NAME@/files/Templates
  • CommonTemplates
    • Windows Path = C:\ProgramData\Microsoft\Windows\Templates
    • Xamarin Mono = /usr/share/templates
    • Xamarin iOS = /usr/share/templates
    • Xamarin Android = /usr/share/templates
  • Resources
    • Windows Path = C:\WINDOWS\resources
    • Xamarin iOS = /Library
  • AdminTools
  • CommonAdminTools
  • CommonDesktopDirectory
  • CommonDocuments
  • CommonMusic
  • CommonPictures
  • CommonProgramFiles
  • CommonProgramFilesX86
  • CommonPrograms
  • CommonStartMenu
  • CommonStartup
  • CommonVideos
  • Cookies
  • DesktopDirectory (Same as Desktop)
  • Favorites
  • Fonts
  • History
  • LocalizedResources
  • MyComputer
  • MyMusic
  • MyPictures
  • MyVideos
  • NetworkShortcuts
  • Personal (Same as MyDocuments)
  • PrinterShortcuts
  • ProgramFiles
  • ProgramFilesX86
  • Programs
  • Recent
  • SendTo
  • StartMenu
  • Startup
  • System
  • SystemX86
  • Windows