FeatureConfigureFeaturesFromSuite

InstallShield 2019 » InstallScript Language Reference

Project • This information applies to InstallScript projects.

Note • This function is available for InstallScript installations that may be included as InstallScript packages in an Advanced UI or Suite/Advanced UI installation. It is also available in an InstallScript installation that is included in an Advanced UI or Suite/Advanced UI installation as an executable package. For more information, see Adding an InstallScript Package to an Advanced UI or Suite/Advanced UI Project.

In addition, this function is available in an InstallScript installation that is launched directly (that is, not from an Advanced UI or Suite/Advanced UI installation).

The FeatureConfigureFeaturesFromSuite function 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).

The FeatureConfigureFeaturesFromSuite function also lets you set the feature state for InstallScript installations that are launched as an executable package in an Advanced UI or Suite/Advanced UI installation, or that are launched directly outside an Advanced UI or Suite/Advanced UI installation. In these cases, the function sets feature states based on the ISFeatureInstall and ISFeatureRemove key-value pairs.

Syntax

FeatureConfigureFeaturesFromSuite (string szCommandLine);

Parameters

FeatureConfigureFeaturesFromSuite Parameters

Parameter

Description

szCommandLine

Specify the command line that you want to use to set ISFeatureInstall, ISFeatureRemove, or both. Set these to a comma-delimited list of feature names as follows:

ISFeatureInstall=Feature1,Feature2 ISFeatureRemove=Feature3

In the above example, Feature1 and Feature2 are selected to be installed; Feature3 is selected to be removed, if it is present.

If any features are used in the values of both properties, the features that are set for the ISFeatureRemove property supersede the ISFeatureInstall property.

If szCommandLine does not set either property or both properties, the call to FeatureConfigureFeaturesFromSuite has no effect.

To learn how to refer to top-level features and subfeatures for ISFeatureInstall and ISFeatureRemove, see Specifying Features and Subfeatures in Function Calls.

Return Values

This function has no return values.

See Also