FeatureRemoveAllInMediaAndLog

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to InstallScript projects.

The FeatureRemoveAllInMediaAndLog function is called during an update installation to force the removal of all features that were installed previously—both those that are in the current media, and those that are not in the current media but are recorded in the setup log file.

Syntax

FeatureRemoveAllInMediaAndLog ( );

Parameters

None.

Return Values

FeatureRemoveAllInMediaAndLog Return Values

Return Value

Description

0

Indicates that the function successfully deselected all feature selections.

< 0

Indicates that the function was unable to deselect all feature selections.

You can obtain the error message text associated with a large negative return value—for example, -2147024891 (0x80070005)—by calling FormatMessage.

Additional Information

Calling FeatureRemoveAllInMediaAndLog is equivalent to calling both FeatureRemoveAllInMedia and FeatureRemoveAllInLogOnly.

Calling FeatureRemoveAllInMediaAndLog causes all features that were installed previously to be deselected. As a result, when FeatureTransferData is called, those features will be removed (uninstalled).

The installation determines whether or not features have been previously installed by reading the setup log file. If no valid log file is found during installation initialization (MAINTENANCE is FALSE), all features are considered not installed. In this case, calling FeatureRemoveAllInMediaAndLog will cause all features to be deselected and not installed. However, a subsequent call to FeatureTransferData will not uninstall anything (since the log file contains the information regarding what to uninstall). Calling FeatureRemoveAllInMediaAndLog in this case is not recommended.

Note: FeatureRemoveAllInMediaAndLog will also deselect all internal features, including the maintenance/uninstallation feature.

See Also