System Variables

InstallShield 11 » InstallScript Language Reference

System variables are predefined variables that contain information such as the source path, the target path, the Windows folder, and the Windows system folder. InstallShield automatically initializes these system variables when the setup process begins, and it is not necessary to declare these variables in your script.

Note

Many Windows Installer directory properties—such as INSTALLDIR, AppDataFolder, and TempFolder—are available directly as variables in your script.

The following list describes all of the InstallScript system variables:

System Variable Description
BATCH_INSTALL Indicates whether or not a locked file was encountered while transferring files with the LOCKEDFILE or SHAREDFILE option.
CMDLINE Specifies the command-line parameter to be passed through Setup.exe with the /z switch.
COMMONFILES Stores the fully qualified path to the Common Files folder.
COMMONFILES64 Stores the fully qualified path to the 64-bit Common Files folder.
DISK1TARGET Stores the path to the folder in which copies of certain of the setup's files are placed to enable maintenance setups and uninstallation.
ERRORFILENAME Stores the name of the file at which an error occurred.
FOLDER_APPLICATIONS Stores the fully qualified path to the Windows Applications folder.
FOLDER_APPLICATIONS64 Stores the fully qualified path to the Windows 64-bit Applications folder.
FOLDER_DESKTOP Stores the fully qualified path to the Windows Desktop folder.
FOLDER_PROGRAMS Stores the fully qualified path to the Windows Start Menu\Programs folder.
FOLDER_STARTMENU Stores the fully qualified path to the Windows Start Menu folder.
FOLDER_STARTUP Stores the fully qualified path to the Windows Startup folder.
INFOFILENAME Specifies the name of a backup file created by InstallShield.
INSTALLDIR Contains the fully qualified path to the target folder on the hard disk. It is initialized to the value of the Windows Installer property INSTALLDIR when the sequence begins, and it cannot be assigned a value.
ISMSI_HANDLE Contains the a handle to the running .msi database.
ISRES Contains the fully qualified file name of the _isres.dll loaded for the current instance of InstallShield.
ISUSER Contains the fully qualified file name of the _isuser.dll loaded for the current instance of InstallShield.
ISVERSION Contains the version of Setup.exe that is running.
MAINTENANCE Indicates whether an installation is a maintanence or a first-time installation.
MEDIA Stores the name of the current file media library.
MODE Indicates whether an InstallScript-based installation program is running in normal, silent, or record mode.
PRODUCT_GUID Contains a GUID for the setup.
PROGRAMFILES Stores the fully qualified path to the Program Files folder.
PROGRAMFILES64 Stores the full path of the predefined 64-bit Program Files folder.
REGDB_OPTIONS Stores registry options.
REINSTALLMODE Indicates when a reinstallation or repair operation is occuring.
SELECTED_LANGUAGE Contains the numeric language code of the language the setup is using.
SHELL_OBJECT_FOLDER Contains the fully qualified name of the folder that was selected in SelectFolder; this variable can be referenced by the Displayed Folder/Group Name property.
SRCDIR Contains the fully qualified path to the source folder. It is initialized to the value of the Windows Installer property SourceDir when the sequence begins, and it cannot be assigned a value.
SRCDISK Contains the name of the drive with the source disk.
SUPPORTDIR Contains the fully qualified path to the folder used for temporary files.
SYSINFO Contains information that identifies the operating platform on the target computer.
SYSPROCESSORINFO Contains information that identifies the processor on the target computer.
TARGETDISK Contains name of the target destination disk.
UNINST Contains the command line to launch setup for uninstallation.
UNINSTALLKEY Contains the name of the registry key in which your uninstallation information will be placed.
UNINSTALL_DISPLAYNAME Contains the product name that will be displayed in the user's Add/Remove Programs panel.
UNINSTALL_STRING Contains the command line that will launch the copy of Setup.exe that was placed on the target system to perform uninstallation. (Used by InstallScript-based installation projects only.)
WINDIR Contains the fully qualified path to the folder that contains the main operating environment.
WINDISK Contains the name of the disk that contains the main operating environment.
WINSYSDIR Contains fully qualified path to the Windows system folder.
WINSYSDIR64 Contains fully qualified path to the 64-bit system folder.
WINSYSDISK Contains the name of the disk that contains the Windows system folder.