EnterDisk

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

Basic MSI
InstallScript
InstallScript MSI

The EnterDisk function displays a message box that prompts the end user to insert the next disk. The system variable SRCDIR contains the default path, which is displayed on the message box. The end user can modify the default path by typing a new path and clicking OK.

EnterDisk recognizes the correct disk by searching the disk for the tag file specified by szTagFile. If the disk does not contain the tag file, the function calls the EnterDiskError function to display an error message box that prompts the end user to enter the correct disk. At build time, InstallShield does not automatically generate tag files in the disk image folders. To use tag files, add them to the disk image folders after the folders are built.

Note: You cannot use the PlaceWindow function in conjunction with the EnterDisk function. By default, the message box appears in the center of the desktop, unless the background window mode is enabled. If the installation is in window mode, the message box opens in the center of the background window.

The default title is Setup Needs the Next Disk. To change the title, call SetDialogTitle before calling EnterDisk.

Syntax

EnterDisk (szMsg, szTagFile);

Parameters

EnterDisk Parameters

Parameter

Description

szMsg

Specifies the message that prompts the end user to insert the proper disk.

szTagFile

Specifies the name of the tag file. EnterDisk searches for this file on the inserted disk. If the file is not found, the function calls the EnterDiskError function to display a message that asks the user to insert the correct disk. If you pass a null string ("") in this parameter, the function does not search for any file; it assumes that the correct disk is being used.

Return Values

EnterDisk Return Values

Return Value

Description

OK (1)

Indicates that the user clicked the OK button.

< 0

Indicates that an unspecified error has occurred.

Additional Information

The dialog that is displayed by the EnterDisk function cannot be displayed with a skin; it appears the same regardless of whether you have specified a skin.

See Also