Burn Built-in Variables
The Burn engine offers a set of commonly-used variables so you can use them without defining your own. Here is the list of
the built-in variable names:
- AdminToolsFolder - gets the well-known folder for CSIDL_ADMINTOOLS.
- AppDataFolder - gets the well-known folder for CSIDL_APPDATA.
- CommonAppDataFolder - gets the well-known folder for CSIDL_COMMON_APPDATA.
- CommonFiles64Folder - gets the well-known folder for FOLDERID_ProgramFilesCommonX64.
- CommonFilesFolder - gets the well-known folder for CSIDL_PROGRAM_FILES_COMMONX86.
- CompatibilityMode - non-zero if the operating system launched the bootstrapper in compatibility mode.
- DesktopFolder - gets the well-known folder for CSIDL_DESKTOP.
- FavoritesFolder - gets the well-known folder for CSIDL_FAVORITES.
- FontsFolder - gets the well-known folder for CSIDL_FONTS.
- LocalAppDataFolder - gets the well-known folder for CSIDL_LOCAL_APPDATA.
- MyPicturesFolder - gets the well-known folder for CSIDL_MYPICTURES.
- NTProductType - numeric product type from OS version information.
- NTSuiteBackOffice - non-zero if OS version suite is Back Office.
- NTSuiteDataCenter - non-zero if OS version suite is Datacenter.
- NTSuiteEnterprise - non-zero if OS version suite is Enterprise.
- NTSuitePersonal - non-zero if OS version suite is Personal.
- NTSuiteSmallBusiness - non-zero if OS version suite is Small Business.
- NTSuiteSmallBusinessRestricted - non-zero if OS version suite is Restricted Small Business.
- NTSuiteWebServer - non-zero if OS version suite is Web Server.
- PersonalFolder - gets the well-known folder for CSIDL_PERSONAL.
- Privileged - non-zero if the process is running elevated (on Vista+) or as an Administrator (on Windows XP).
- ProgramFiles64Folder - gets the well-known folder for FOLDERID_ProgramFilesX64.
- ProgramFilesFolder - gets the well-known folder for CSIDL_PROGRAM_FILESX86
- ProgramMenuFolder - gets the well-known folder for CSIDL_PROGRAMS.
- RebootPending - non-zero if the system requires a reboot. Note that this value will reflect the reboot status of the system when the variable is first requested.
- SendToFolder - gets the well-known folder for CSIDL_SENDTO.
- ServicePackLevel - numeric value representing the installed OS service pack.
- StartMenuFolder - gets the well-known folder for CSIDL_STARTMENU.
- StartupFolder - gets the well-known folder for CSIDL_STARTUP.
- SystemFolder - gets the well-known folder for CSIDL_SYSTEMX86.
- SystemLanguageID - gets the language ID for the system locale.
- TempFolder - gets the well-known folder for temp location
- TemplateFolder - gets the well-known folder for CSIDL_TEMPLATES.
- TerminalServer - non-zero if the system is running in application server mode of Remote Desktop Services.
- UserLanguageID - gets the language ID for the current user locale.
- VersionMsi - version value representing the Windows Installer engine version.
- VersionNT - version value representing the OS version.
- VersionNT64 - version value representing the OS version if 64-bit. Undefined if running a 32-bit operating system.
- WindowsFolder - gets the well-known folder for CSIDL_WINDOWS.
- WindowsVolume - gets the well-known folder for the windows volume.
- WixBundleDirectoryLayout - set to the folder provided to the -layout switch (default is directory containin the bundle executable). This variable can also be set by the bootstrapper application to modify where files will be laid out.
- WixBundleName - gets the name of the bundle (from Bundle/@Name). This variable can also be set by the bootstrapper application to modify the bundle name at runtime.
- WixBundleProviderKey - gets the bundle dependency provider key.
- WixBundleTag - gets the developer-defined tag string for this bundle (from Bundle/@Tag).