Installer Variables Reference

Top  Previous  Next

Each installation project can contain paths to known folders for example, to Program Files, My Documents, Windows System folder etc. But using hard-coded paths to this folders may cause problems because such paths are different on various platforms. For example, the Windows folder may be "C:\Windows" on one system and "C:\Winnt" on another.

Another common installation problem is using known strings in several places: product and company name, product version and installation folder.

AWinstall supports a set of installer variables that can help you in solving this problem. Instead of using hardcoded paths use macro form containing installer variable: ${VariableName}.

You can also use Pseudo-Variables for reading Registry data and Environment strings. Please refer to the Pseudo-Variables reference for more details.

The list of built-in AWinstall variables is provided below. You may create a new variables using Script actions.

Variable name

Value

User-defined

CompanyName

Your company name

Yes

ProductName

Installation product name

Yes

ProductVersion

Installation product version

Yes

ProductMenu

Folder for creating program menu shortcuts

Yes1

ProductPath

Folder for creating product files and folders

Yes

IsUserAnAdmin

Contains "1" if the current user has Administrator privileges; otherwise contains "0".

No

NetFrameworkFullVersion

Full version number of .NET Framework installed, for example: "2.0.50727"

No

NetFrameworkShortVersion

Short form of the .NET Framework version number, for example: "2.0"

No

WindowTitle

Installer window title

Yes

UninstallTitle

Uninstaller window title

Yes

InstallerPath

The path to folder containing installer executable

No

InstallerFile

The name of the installer executable. For example: setup.exe

No

DesktopPath

Desktop folder

No

FontsPath

System fonts folder

No

MyDocumentsPath

'My Documents' folder

No

ProgramsPath

'Program Files' folder

No

CommonFiles

'Common files' folder

No

SystemPath

Windows System (System32) folder

No

QuickLaunch

Quick Launch folder

No

UserAppData

'Application Data' folder2

No

CommonAppData

'Application Data' folder for all users3

No

Favorites

The Internet Explorer "Favorites" folder

No

CommonFavorites

The "Favorites" folder for all users

No

TempPath

Temporary files folder

No

WindowsPath

Windows folder

No

CommonProgramsMenu

Common Programs menu folder

No

CommonDesktopPath

Common Desktop folder

No

CommonStartMenu

Common Start menu folder

No

CommonStartupMenu

Common Startup menu folder

No

UserProgramsMenu

User Programs menu folder

No

UserStartMenu

User Start menu folder

No

UserStartupMenu

User Startup menu folder

No

UninstallCommand

Path to uninstaller executable

No

UninstallLog

Path to uninstall log file

No

1This variable is recommended for simple managing Start menu shortcuts. You can choose it value in 'Project Settings' dialog ('Folders' page):

menufolder

If you will choose 'User Menu' item, this folder will address to ${UserProgramsMenu}\${ProductName}. Else it will point to ${CommonProgramsMenu}\${ProductName}. During installation, you can allow users to change this folder.

2This folder may not exist on older systems (Windows® 95 or Windows® NT without the Microsoft® Internet Explorer 4.0 integrated Shell installed).

3This folder may not exist on older systems (Windows® 95/98 or Windows® NT without the Microsoft® Internet Explorer 5.0).