FeatureGetTotalCost

InstallShield 2014 » InstallScript Language Reference

Note: This function is obsolete. Use the FeatureGetCostEx function instead.

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The FeatureGetTotalCost function determines the total space, in kilobytes (KB), required on the target drive for the feature installations and uninstallations that have been specified (for example, by end user selections in feature or setup type dialogs). When determining required drive space, this function takes into account which features are currently selected, whether any components associated with the features are currently filtered by operating system or language, and the cluster size on the target drive.

Syntax

FeatureGetTotalCost ( szFeatureSource, szTargetDir, nvTotalRequiredSpace );

Parameters

FeatureGetTotalCost Parameters

Parameter

Description

szFeatureSource

Specifies the media name of the file media whose features have been specified for installation and uninstallation. Typically, you would pass the system variable MEDIA in this parameter.

szTargetDir

Specifies the drive that is used, or the path whose drive is used, in determining required drive space. Typically, you would pass the system variable TARGETDIR in this parameter.

nvTotalRequiredSpace

Returns the required drive space, in KB.

Return Values

FeatureGetTotalCost Return Values

Return Value

Description

0

Indicates that the function successfully determined the required drive space.

< 0

Indicates that the function could not determine the required drive space.

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

See Also