SetStatusWindow

InstallShield 2019 ยป InstallScript Language Reference

The SetStatusWindow function sets an initial or current value for the percentage complete indicator of the progress indicator (status bar) and specifies the current message to display on the top line of the progress indicator.

Setups that install files using the FeatureMoveData function must call SetStatusWindow before calling FeatureMoveData in order to set the percentage complete indicator to 0% and clear the top line of the indicator. No additional calls to SetStatusWindow are required. The 'Status Text' string for each feature is displayed on the top line of the status bar automatically while the files of the feature are being installed.

Before calling FeatureMoveData, your setup should also call the StatusUpdate function to enable automatic updating of the percentage complete indicator during file transfer. To enable the display of the name and path of the file being installed on the second line of the status bar, call Enable with the INDVFILESTATUS parameter before calling FeatureMoveData. After these calls, the percentage complete indicator is updated smoothly during file transfer and the names of individual files are displayed as they are transferred when the FeatureMoveData function is called.

Setups that install files using the CopyFile or XCopyFile functions may need to make multiple calls to SetStatusWindow in order to change the message on the top line of the indicator between successive calls to CopyFile or XCopyFile. StatusUpdate and Enable (with the parameter INDVFILESTATUS) work normally with CopyFile and XCopyFile. It is not necessary to call SetStatusWindow to change the percentage complete indicator between successive calls to CopyFile or XCopyFile if you have called StatusUpdate to enable automatic updating.

Syntax

SetStatusWindow ( nPercent, szString );

Parameters

SetStatusWindow Parameters

Parameter

Description

nPercent

Specifies a value between 0 and 100 that represents the percentage to be displayed by the percentage complete indicator. To reset the indicator before calling FeatureMoveData, specify 0. To change the message displayed on the top line of the status bar without changing the percentage complete indicator, specify -1 in this parameter.

szString

Specifies a string to display on the top line of the status bar. Note that if a 'DisplayText' parameter has been specified for this feature (in the IDE), that string automatically overwrites any text specified in this parameter when FeatureMoveData is called.

Return Values

This function does not return a value.

See Also