Suite/Advanced UI and Advanced UI Interaction Functions

InstallShield 2015 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
Suite/Advanced UI

Note: All of these functions are available for InstallScript installations that may be included as InstallScript packages in an Advanced UI or Suite/Advanced UI installation. For more information, see Adding an InstallScript Package to an Advanced UI or Suite/Advanced UI Project.

Furthermore, all of these functions except for FeatureConfigureFeaturesFromSuite and SuiteReportError are available for InstallScript actions that are included in Suite/Advanced UI installations. For more information, see Working with an Action that Runs InstallScript Code in a Suite/Advanced UI Installation.

The FeatureConfigureFeaturesFromSuite is also available in the following scenarios; however, the other Advanced UI or Suite/Advanced UI functions return an error:

The function is called in an InstallScript installation that is launched directly (that is, not from an Advanced UI or Suite/Advanced UI installation).
The function is called in an InstallScript installation that is included in an Advanced UI or Suite/Advanced UI installation as an executable package.

InstallScript includes the following functions for interacting with an Advanced UI or Suite/Advanced UI installation that contains an InstallScript package. These functions (with the exception of FeatureConfigureFeaturesFromSuite) are also available for interacting with the running Suite/Advanced UI installation through an InstallScript action.

Suite/Advanced UI and Advanced UI Interaction Functions

Function

Description

FeatureConfigureFeaturesFromSuite

Sets feature states for the current InstallScript package that is running in an Advanced UI or Suite/Advanced UI installation based on the values of the Advanced UI or Suite/Advanced UI properties ISFeatureInstall and ISFeatureRemove. The function is called by the default code in the OnSuiteInstallBefore event (for an install operation) and OnSuiteMaintBefore event (for a modify operation).

SuiteFormatString

Resolves Advanced UI or Suite/Advanced UI properties in a string with values from the Advanced UI or Suite/Advanced UI installation.

SuiteGetProperty

Retrieves the value of an Advanced UI or Suite/Advanced UI property from the Advanced UI or Suite/Advanced UI installation.

SuiteLogInfo

Logs information about the InstallScript package or action that is running in an Advanced UI or Suite/Advanced UI installation to the Advanced UI or Suite/Advanced UI debug log.

SuiteReportError

Displays a message box in the Advanced UI or Suite/Advanced UI user interface to report an error that occurred as the Advanced UI or Suite/Advanced UI installation ran the InstallScript package.

SuiteResolveString

Replaces an Advanced UI or Suite/Advanced UI string identifier with its corresponding string value in the InstallScript package or action that is running in an Advanced UI or Suite/Advanced UI installation.

SuiteSetProperty

Sets the value of an Advanced UI or Suite/Advanced UI property in the Advanced UI or Suite/Advanced UI installation.

See Also