FeatureIsItemSelected

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

In Windows Installer–based projects, FeatureIsItemSelected determines the current installed state of the specified feature. In InstallScript projects, FeatureIsItemSelected determines the current selection state of the specified feature. You can also use FeatureGetData to determine if a feature is selected.

FeatureIsItemSelected is typically called to perform feature-specific tasks before or after file transfer. To perform feature-specific tasks during file transfer in an InstallScript installation, it is recommended that you place code in feature event handler functions.

Syntax

FeatureIsItemSelected ( szFeatureSource, szFeature );

Parameters

FeatureIsItemSelected Parameters

Parameter

Description

szFeatureSource

Specifies the media name of the script-created feature set or (in InstallScript projects) file media library for which the installed state or selection setting is determined.

szFeature

Specifies the name of the feature for which the installed state or selection setting is determined. To learn how to refer to top-level features and subfeatures, see Specifying Features and Subfeatures in Function Calls.

Return Values

FeatureIsItemSelected Return Values

Return Value

Description

TRUE (1)

In Windows Installer based projects, szFeature's installed state is INSTALLSTATE_LOCAL (feature was installed on the local drive).

In InstallScript projects, szFeature is selected.

FALSE (0)

In Windows Installer based projects, szFeature's installed state is INSTALLSTATE_ABSENT (feature was uninstalled).

In InstallScript projects, szFeature is deselected.

< 0

The function failed to determine if the feature was installed or selected. Call FeatureError for additional information.

See Also