SdDiskSpace2

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The SdDiskSpace2 function displays a dialog that shows either of the following:

A list view of volumes, required space, available space, and the difference between available space and required space.
A warning message indicating that the target system does not have enough available space for the installation to take place. The dialog also displays a list view of volumes, required space, available space, and the difference between available space and required space.

The SdDiskSpace2 function supersedes the SdDiskSpaceRequirements and SdOutOfDiskSpace functions.

Syntax

SdDiskSpace2 (szTitle, szMsg, bUseOutOfSpaceDialog);

Parameters

SdDiskSpace2 Parameters

Parameter

Description

szTitle

Specifies the title of the dialog. To display the default title (“Disk Space Requirements” or “Out of Disk Space”), pass a null string ("") in this parameter.

szMsg

Specifies the message to display in the dialog. This text is considered a static control. To display the default instructions for this dialog, pass a null string ("") in this parameter.

bUseOutOfSpaceDialog

Indicates whether to show the dialog that warns that the installation is out of space or the dialog that shows the disk space requirements. Pass one of the following predefined constants in this parameter:

TRUE—Show the dialog that displays a warning message indicating that the target system does not have enough available space for the installation to take place. The dialog also displays a list view of volumes, required space, available space, and the difference between available space and required space.
FALSE—Show the dialog that displays a list view of volumes, required space, available space, and the difference between available space and required space.

Return Values

SdDiskSpace2 Return Values

Return Value

Description

NEXT (1)

Indicates that the end user clicked the OK button.

Additional Information

Project: In InstallScript MSI installations, the OnOutOfDiskSpace event handler responds to the Out Of Disk Space event. The default implementation of OnOutOfDiskSpace displays the SdDiskSpace2 dialog, and then aborts the installation.

To view an example of this or other dialogs for your installation, use the Dialog Sampler. In InstallShield, on the Tools menu, point to InstallScript, then click Standard Dialog Sampler or Skinned Dialog Sampler.

See Also