Edit

Share via


Recognized environment variables

When the XML files MigDocs.xml, MigApp.xml, and MigUser.xml are used, the environment variables can be used to identify folders that can be different on different computers. Constant special item ID list (CSIDL) values provide a way to identify folders that applications use frequently but could have different names or locations on any given computer. For example, the Documents folder could be C:\Users\<Username>\Documents on one computer and C:\Users\<Username>\My Documents on another. The asterisk (*) wildcard character can be used in the MigUser.xml, MigApp.xml and MigDoc.xml files. However, the asterisk (*) wildcard character can't be used in the Config.xml file.

Variables that are processed for the operating system and in the context of each user

These variables can be used within sections in the .xml files with context=UserAndSystem, context=User, and context=System.

VariableExplanation
ALLUSERSAPPDATASame as CSIDL_COMMON_APPDATA.
ALLUSERSPROFILERefers to %PROFILESFOLDER%\Public or %PROFILESFOLDER%\all users.
COMMONPROGRAMFILESSame as CSIDL_PROGRAM_FILES_COMMON.
COMMONPROGRAMFILES(X86)Refers to the C:\Program Files (x86)\Common Files folder on 64-bit systems.
CSIDL_COMMON_ADMINTOOLSVersion 10.0. The file-system directory that contains administrative tools for all users of the computer.
CSIDL_COMMON_ALTSTARTUPThe file-system directory that corresponds to the non-localized Startup program group for all users.
CSIDL_COMMON_APPDATAThe file-system directory that contains application data for all users. A typical path Windows is C:\ProgramData.
CSIDL_COMMON_DESKTOPDIRECTORYThe file-system directory that contains files and folders that appear on the desktop for all users. A typical path is C:\Users\Public\Desktop.
CSIDL_COMMON_DOCUMENTSThe file-system directory that contains documents that are common to all users. A typical path is C:\Users\Public\Documents.
CSIDL_COMMON_FAVORITESThe file-system directory that serves as a common repository for favorites common to all users. A typical path is C:\Users\Public\Favorites.
CSIDL_COMMON_MUSICThe file-system directory that serves as a repository for music files common to all users. A typical path is C:\Users\Public\Music.
CSIDL_COMMON_PICTURESThe file-system directory that serves as a repository for image files common to all users. A typical path is C:\Users\Public\Pictures.
CSIDL_COMMON_PROGRAMSThe file-system directory that contains the directories for the common program groups that appear on the Start menu for all users. A typical path is C:\ProgramData\Microsoft\Windows\Start Menu\Programs.
CSIDL_COMMON_STARTMENUThe file-system directory that contains the programs and folders that appear on the Start menu for all users. A typical path in Windows is C:\ProgramData\Microsoft\Windows\Start Menu.
CSIDL_COMMON_STARTUPThe file-system directory that contains the programs that appear in the Startup folder for all users. A typical path is C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup.
CSIDL_COMMON_TEMPLATESThe file-system directory that contains the templates that are available to all users. A typical path is C:\ProgramData\Microsoft\Windows\Templates.
CSIDL_COMMON_VIDEOThe file-system directory that serves as a repository for video files common to all users. A typical path is C:\Users\Public\Videos.
CSIDL_DEFAULT_APPDATARefers to the Appdata folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_LOCAL_APPDATARefers to the local Appdata folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_COOKIESRefers to the Cookies folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_CONTACTSRefers to the Contacts folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_DESKTOPRefers to the Desktop folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_DOWNLOADSRefers to the Downloads folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_FAVORITESRefers to the Favorites folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_HISTORYRefers to the History folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_INTERNET_CACHERefers to the Internet Cache folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_PERSONALRefers to the Personal folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_MYDOCUMENTSRefers to the Documents folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_MYPICTURESRefers to the Pictures folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_MYMUSICRefers to the Music folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_MYVIDEORefers to the Videos folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_RECENTRefers to the Recent folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_SENDTORefers to the Send To folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_STARTMENURefers to the Start Menu folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_PROGRAMSRefers to the Programs folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_STARTUPRefers to the Startup folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_TEMPLATESRefers to the Templates folder inside %DEFAULTUSERPROFILE%.
CSIDL_DEFAULT_QUICKLAUNCHRefers to the Quick Launch folder inside %DEFAULTUSERPROFILE%.
CSIDL_FONTSA virtual folder containing fonts. A typical path is C:\Windows\Fonts.
CSIDL_PROGRAM_FILESX86The Program Files folder on 64-bit systems. A typical path is C:\Program Files (x86).
CSIDL_PROGRAM_FILES_COMMONX86A folder for components that are shared across applications on 64-bit systems. A typical path is C:\Program Files (x86)\Common.
CSIDL_PROGRAM_FILESThe Program Files folder. A typical path is C:\Program Files.
CSIDL_PROGRAM_FILES_COMMONA folder for components that are shared across applications. A typical path is C:\Program Files\Common.
CSIDL_RESOURCESThe file-system directory that contains resource data. A typical path is C:\Windows\Resources.
CSIDL_SYSTEMThe Windows System folder. A typical path is C:\Windows\System32.
CSIDL_WINDOWSThe Windows directory or system root path. This value corresponds to the %WINDIR% or %SYSTEMROOT% environment variables. A typical path is C:\Windows.
DEFAULTUSERPROFILERefers to the value in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList [DefaultUserProfile].
PROFILESFOLDERRefers to the value in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList [ProfilesDirectory].
PROGRAMFILESSame as CSIDL_PROGRAM_FILES.
PROGRAMFILES(X86)Refers to the C:\Program Files (x86) folder on 64-bit systems.
SYSTEMRefers to %WINDIR%\system32.
SYSTEM16Refers to %WINDIR%\system.
SYSTEM32Refers to %WINDIR%\system32.
SYSTEMDRIVEThe drive that holds the Windows folder. This value is a drive name and not a folder name (C: not C:\).
SYSTEMPROFILERefers to the value in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList\S-1-5-18 [ProfileImagePath].
SYSTEMROOTSame as WINDIR.
WINDIRRefers to the Windows folder located on the system drive.

Variables that are recognized only in the user context

These variables can be used in the .xml files within sections with context=User and context=UserAndSystem.

VariableExplanation
APPDATASame as CSIDL_APPDATA.
CSIDL_ADMINTOOLSThe file-system directory that is used to store administrative tools for an individual user. The Microsoft Management Console (MMC) saves customized consoles to this directory, which roams with the user profile.
CSIDL_ALTSTARTUPThe file-system directory that corresponds to the user's non-localized Startup program group.
CSIDL_APPDATAThe file-system directory that serves as a common repository for application-specific data. A typical path is C:\Users\<username>\AppData\Roaming.
CSIDL_BITBUCKETThe virtual folder that contains the objects in the user's Recycle Bin.
CSIDL_CDBURN_AREAThe file-system directory acting as a staging area for files waiting to be written to CD. A typical path is C:\Users\<username>\AppData\Local\Microsoft\Windows\MasteredBurning\Disc Burning.
CSIDL_CONNECTIONSThe virtual folder representing Network Connections that contains network and dial-up connections.
CSIDL_CONTACTSThis value refers to the Contacts folder in %CSIDL_PROFILE%.
CSIDL_CONTROLSThe virtual folder that contains icons for the Control Panel items.
CSIDL_COOKIESThe file-system directory that serves as a common repository for Internet cookies. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Cookies.
CSIDL_DESKTOPThe virtual folder representing the Windows desktop.
CSIDL_DESKTOPDIRECTORYThe file-system directory used to physically store file objects on the desktop, which shouldn't be confused with the desktop folder itself. A typical path is C:\Users\<username>\Desktop.
CSIDL_DRIVESThe virtual folder representing This PC that contains everything on the local computer: storage devices, printers, and Control Panel. The folder could also contain mapped network drives.
CSIDL_FAVORITESThe file-system directory that serves as a common repository for the user's favorites. A typical path is C:\Users\<username>\Favorites.
CSIDL_HISTORYThe file-system directory that serves as a common repository for Internet history items.
CSIDL_INTERNETA virtual folder for Internet Explorer.
CSIDL_INTERNET_CACHEThe file-system directory that serves as a common repository for temporary Internet files. A typical path is C:\Users\<username>\AppData\Local\Microsoft\Windows\Temporary Internet Files
CSIDL_LOCAL_APPDATAThe file-system directory that serves as a data repository for local, non-roaming applications. A typical path is C:\Users\<username>\AppData\Local.
CSIDL_MYDOCUMENTSThe virtual folder representing the Documents folder.A typical path is C:\Users\<username>\Documents.
CSIDL_MYMUSICThe file-system directory that serves as a common repository for music files. A typical path is C:\Users\<username>\Music.
CSIDL_MYPICTURESThe file-system directory that serves as a common repository for image files. A typical path is C:\Users\<username>\Pictures.
CSIDL_MYVIDEOThe file-system directory that serves as a common repository for video files. A typical path is C:\Users\<username>\Videos.
CSIDL_NETHOODA file-system directory that contains the link objects that could exist in the Network virtual folder. It isn't the same as CSIDL_NETWORK, which represents the network namespace root. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Network Shortcuts.
CSIDL_NETWORKA virtual folder representing the Network desktop item, the root of the network namespace hierarchy.
CSIDL_PERSONALThe virtual folder representing the <User> desktop item. This value is equivalent to CSIDL_MYDOCUMENTS. A typical path is C:\User\<username>\Documents.
CSIDL_PLAYLISTSThe virtual folder used to store play albums, typically C:\Users\<username>\Music\Playlists.
CSIDL_PRINTERSThe virtual folder that contains installed printers.
CSIDL_PRINTHOODThe file-system directory that contains the link objects that can exist in the Printers virtual folder. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Printer Shortcuts.
CSIDL_PROFILEThe user's profile folder. A typical path is C:\Users\<username>.
CSIDL_PROGRAMSThe file-system directory that contains the user's program groups, which are themselves file-system directories. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs.
CSIDL_RECENTThe file-system directory that contains shortcuts to the user's most recently used documents. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Recent.
CSIDL_SENDTOThe file-system directory that contains Send To menu items. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\SendTo.
CSIDL_STARTMENUThe file-system directory that contains Start menu items. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Start Menu.
CSIDL_STARTUPThe file-system directory that corresponds to the user's Startup program group. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup.
CSIDL_TEMPLATESThe file-system directory that serves as a common repository for document templates. A typical path is C:\Users\<username>\AppData\Roaming\Microsoft\Windows\Templates.
HOMEPATHSame as the standard environment variable.
TEMPThe temporary folder on the computer. A typical path is %USERPROFILE%\AppData\Local\Temp.
TMPThe temporary folder on the computer. A typical path is %USERPROFILE%\AppData\Local\Temp.
USERPROFILESame as CSIDL_PROFILE.
USERSIDRepresents the current user-account security identifier (SID). For example, S-1-5-21-1714567821-1326601894-715345443-1026.

USMT XML reference