FeatureSpendCost

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to InstallScript projects:

The FeatureSpendCost function tells the setup that the progress bar should be updated for a certain amount of cost that has been spent by an event external to the setup. This function has the effect of updating the progress bar appropriately as if the setup itself had spent the corresponding amount of cost. This function can only be called during a standard file operation event, such as an event resulting from calling FeatureTransferData or FeatureMoveData. Typically, this function is called during the OnInstalling or OnInstalled event as a result of an external event occurring that spends cost.

Note: It is not necessary to call this function for file transfer operations that the setup engine carries out, such as XCopyFile or CopyFile. These mechanisms automatically update the status bar during operation. However, FeatureAddCost must be called in this case (before file transfer operations begin) so the installation is aware of the additional cost.

Syntax

FeatureSpendCost ( nCostHigh, nCostLow );

Parameters

FeatureSpendCost Parameters
Parameter	Description
nCostHigh	Specifies the upper 31 bits of the installation cost that should be spent.
nCostLow	Specifies the lower 31 bits of the installation cost that should be spent.

Return Values

FeatureSpendCost Return Values
Return Value	Description
ISERR_SUCCESS	Indicates that the function successfully updated the progress bar.
< ISERR_SUCCESS	Indicates that the function was unable to update the progress bar.

FeatureSpendCost

InstallShield 2014 Help Library

May 2014