Special Registry-Related Functions

InstallShield 2020 ยป InstallScript Language Reference

The special registry-related functions are designed to make it easier for script writers to set up the minimum required registry keys and values. The special registry-related functions work only with the per application paths key, the application uninstallation key, or the application information key, as shown below. Refer to the individual function descriptions for more details.

Per Application Paths Key

<root key>\Software\Microsoft\Windows\CurrentVersion\App Paths\<per application paths key>

This key is referred to as the per application paths key, or App Paths key. The per application paths key stores path information enabling Windows to find your application's executable files. The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise.

Per Application Paths Key

Function

Description

CreateInstallationInfo

Uses the name of the application executable file to prepare for the creation of the per application paths key. The key is not created until RegDBSetItem is called (see below).

If you use an event-based script, the CreateInstallationInfo function is called by the default OnMoveData event handler code.

RegDBDeleteItem

Deletes the per application paths key and the value of [Path] or of [DefaultPath] under that key.

RegDBGetItem

Retrieves the value of [Path] or of [DefaultPath] under the per applications path key.

RegDBSetItem

Results in the creation of the per application paths key, and sets the value of [Path] or of [DefaultPath] under that key.

Application Uninstallation Key

<rootkey>\Software\Microsoft\Windows\CurrentVersion\Uninstall\<INSTANCE_GUID>

This key is referred to as the application uninstallation key. The application uninstallation key stores information enabling uninstallation functionality. The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise.

Application Uninstallation Key

Function

Description

MaintenanceStart

Creates the application uninstallation key and sets the [UninstallString], [DisplayName] (the name displayed in Add or Remove Programs), and [LogFile] values under that key.

In an event-based script, MaintenanceStart is called in the default OnMoveData event handler code.

RegDBDeleteItem

Deletes the value of [DisplayName] (the name displayed in Add or Remove Programs) under the application uninstallation key.

RegDBGetItem

Retrieves the value of [DisplayName] under the application uninstallation key.

RegDBSetItem

Sets the value of [DisplayName] (the name displayed in Add or Remove Programs) under the application uninstallation key.

This value is also set by MaintenanceStart (which, if you use an event-based script, is called in the default OnMoveData event handler code).

Application Information Key

<root key>\Software\<company key>\<product key>\<version key>

This key is referred to as the application information key. Your installation should create an application information key for each application it installs. The application information key stores information about the application. The root key is HKEY_CURRENT_USER if the ALLUSERS system variable is FALSE or you have called ProgDefGroupType(PERSONAL), or HKEY_LOCAL_MACHINE otherwise.

Application Information Key

Function

Description

CreateInstallationInfo

Uses the company name, product name, and product version number to create the application information key. No values are set under the key until you call the RegDBSetAppInfo function (see below).

If you use an event-based script, the CreateInstallationInfo function is called by the default OnMoveData event handler code.

RegDBGetAppInfo

Retrieves a value from under the application information key.

RegDBSetAppInfo

Sets a value under the application information key.