InstallShield 2016 » InstallScript Language Reference
Some of the following functions create simple dialogs, such as Yes/No dialogs and message boxes. Several functions let you easily display various types of common dialogs. Other functions are script dialog (Sd) functions. Sd dialogs are created using special InstallScript definition functions that create a dialog with custom input. The dialogs then automatically return values to the script based on the selected action.
Note • Dialogs that have a Cancel button do not return a CANCEL value when that button is clicked. Instead, the OnCanceling event handler is called.
Function |
Project Type |
Description |
||||||
InstallScript MSI |
Displays a dialog that prompts the end user to enter the path to a destination location for an administrative installation (when the end user runs an InstallScript MSI project’s Setup.exe file with the /a argument). |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that requests destination path information. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that prompts the end user to select options by using check boxes or radio buttons. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that prompts the end user to enter a path. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that prompts the end user to enter text. |
|||||||
Basic MSI, InstallScript, InstallScript MSI |
Presents a message box that prompts the end user to respond to a question by clicking on a Yes or No button. |
|||||||
Basic MSI, InstallScript, InstallScript MSI |
Presents a message box that prompts the end user for a specific disk. |
|||||||
Basic MSI, InstallScript, InstallScript MSI |
Checks whether a specified path and file exists. The function displays an appropriate error message box if the file does not exist in the specified path; then it returns success or failure, depending on whether the specified file exists. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to specify a user name and password. Note that the dialog does not validate or use the specified information. In addition, the dialog does not perform any error checking for the specified information. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that queries the end user for a password; the characters that the end user types in the edit box are displayed as asterisks (*). |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables end users to select features and specify a destination location. |
|||||||
Basic MSI, InstallScript, InstallScript MSI |
Presents a message in a message box. |
|||||||
Basic MSI, InstallScript, InstallScript MSI |
Presents a message in a message box. |
|||||||
InstallScript, InstallScript MSI |
Presents a message box that enables end users to choose to restart the computer. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog that enables end users to select an alternate destination path. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog that enables end users to select an alternate destination path. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog that has greater flexibility than the standard AskOptions function. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables end users to select and deselect items from a list. |
|||||||
InstallScript, InstallScript MSI |
Displays a bitmap on a dialog. |
|||||||
InstallScript, InstallScript MSI |
Displays a message box that prompts the user to confirm the folder selection. |
|||||||
InstallScript, InstallScript MSI |
Displays a message box that prompts the end user to confirm the information that was entered in dialogs presented by SdRegisterUser or SdRegisterUserEx. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to specify the user name and company name for the product being installed. The dialog may also include radio buttons that let the end user specify whether the product should be installed for all users or only the current user. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to specify the user name, company name, and serial number for the product being installed. The dialog may also include radio buttons that let the end user specify whether the product should be installed for all users or only the current user. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that shows either of the following:
|
|||||||
InstallScript, InstallScript MSI |
Displays a list of volumes, required space, available space, and the difference between available and required space. SdDiskSpace2 supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Displays a list of topics. |
|||||||
InstallScript, InstallScript MSI |
Displays a message box informing the end user that a shared, locked (in use), or read-only file has been encountered. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to select features to install and a destination folder. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to select folders, features, and subfeatures to install. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to select features to install and a destination folder. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to select the features and subfeatures to install. Additional information about disk space is also provided to help determine the best location for the installation. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog with a tree control that enables end users to select the features and subfeatures to install. Additional information about disk space is also provided to help determine the best location for the installation. |
|||||||
InstallScript MSI |
Displays a dialog that includes a list box containing a list of the applications that are open and are locking files. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that informs the end user that the setup is complete and offers a choice of options, such as whether to view an information file or launch an application. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog informing the end user that the installation is complete. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that informs the user that the setup is complete and offers a choice of options for restarting Windows and the computer. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that indicates that the installation is complete. The dialog includes the option to check for application updates. Note • SdFinishUpdate does not check for updates; to check for updates, add FlexNet Connect API calls in your InstallScript code. For more information, see the FlexNet Connect SDK documentation. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that indicates that the installation is complete. The dialog includes the option to check for application updates. Note • SdFinishUpdateEx does not check for updates; to check for updates, add FlexNet Connect API calls in your InstallScript code. For more information, see the FlexNet Connect SDK documentation. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that indicates that the installation is complete. The dialog gives the end user the option to restart the system and to check for application updates. Note • SdFinishUpdateReboot does not check for updates; to check for updates, add FlexNet Connect API calls in your InstallScript code. For more information, see the FlexNet Connect SDK documentation. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that contains a license agreement in a multi-line edit field. The license agreement is stored in a text file identified in the parameter szLicenseFile. The dialog shows a question in a static text field. The end user responds by clicking the Yes or No button. The SdLicenseEx function supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that contains a license agreement in a multi-line edit field. The license agreement is stored in a text file identified in the parameter szLicenseFile. The dialog displays two radio buttons (one for accepting the terms of the license agreement, and one for not accepting them). The Next button becomes enabled when the end user clicks the appropriate button to accept the terms of the license agreement. The SdLicense2Ex function supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that contains a license agreement in a multi-line edit field. The license agreement is stored in a text file (.txt) or a rich text file (.rtf) identified in the parameter szLicenseFile. The dialog displays two radio buttons (one for accepting the terms of the license agreement, and one for not accepting them). The Next button becomes enabled when the end user clicks the appropriate button to accept the terms of the license agreement. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that contains a license agreement in a multi-line edit field. The license agreement is stored in a text or rich-text format (RTF) file identified in the parameter szLicenseFile. The dialog displays two radio buttons (one for accepting the terms of the license agreement, and one for not accepting them). The Next button becomes enabled when the end user clicks the appropriate button to accept the terms of the license agreement. The SdLicense2Ex function supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that contains a license agreement in a multi-line edit field. The license agreement is stored in a text file (.txt) or a rich text file (.rtf). The dialog shows a question in a static text field. The end user responds by clicking the Yes or No button. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that contains a license agreement in a multi-line edit field. The license agreement is stored in a text or rich-text format (RTF) file identified in the parameter szLicenseFile. The dialog shows a question in a static text field. The end user responds by clicking the Yes or No button. The SdLicenseEx function supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Displays a message box that enables end users to select a domain or server and a user name. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to enter new user information after the end user clicks the New User Information button on the SdLogonUserInformation dialog. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that prompts the end user for existing user account information or new user information if an account is to be created during the installation. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to select a group from a specified server and populate the Group field in the SdLogonUserCreateUser dialog. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to browse for the domain or server with which the user account is associated. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to browse and select an existing user for a specified domain or server. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog with user-defined buttons that provide an end user with various options. |
|||||||
InstallScript MSI |
When triggered by the Windows Installer’s INSTALLMESSAGE_OUTOFDISKSPACE message, this dialog displays a message indicating that the target system is out of disk space. SdDiskSpace2 supersedes this function. |
|||||||
InstallScript MSI |
Creates a dialog that displays a welcome message to end users during a patch installation. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to specify the user name and company name for the product being installed. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to specify the user name, company name, and serial number for the product being installed. |
|||||||
InstallScript MSI |
Displays a dialog that includes a list box containing a list of the applications that are open and are locking files. The dialog also includes two radio buttons that allow end users to specify whether the installation should attempt to use the Restart Manager to shut down the applications that are locking files or attempting to overwrite the locked files (which most likely results in the need for a reboot to complete the installation). |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables end users to select a folder from a list of program folders. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog to inform the end user that the installation was interrupted before it could be completed. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables the end user to select one of the three standard setup types: Typical, Compact, or Custom. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that enables end users to select one of the two standard setup types: Typical or Custom. |
|||||||
InstallScript MSI |
Displays a dialog that enables end users to select standard or custom setup types. |
|||||||
InstallScript, InstallScript MSI |
Displays a general-purpose dialog from a resource DLL. You cannot receive any input from the end user when showing a dialog with SdShowAnyDialog. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that has one single-line edit field and other static controls. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that has two single-line edit fields and other static controls. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog that has three single-line edit fields and other static controls. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that previews the changes that may be made to a file and enables end users to approve the changes, reject the changes, or request that the changes be written to a file. |
|||||||
InstallScript, InstallScript MSI |
Displays a scrollable list of messages in a dialog. |
|||||||
InstallScript, InstallScript MSI |
Displays a message in a small window. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that displays the options and settings that have been specified by the end user. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that informs the end user that the file transfer process is about to begin. The user can click the Back button to return to previous dialogs in order to change settings as required. |
|||||||
InstallScript, InstallScript MSI |
Displays a general-purpose greeting. |
|||||||
InstallScript, InstallScript MSI |
Displays a dialog for use at the beginning of a maintenance setup. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables end users to select a folder. SelectDir creates the folder if it does not exist. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables end users to select a folder. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables end users to select a folder from a list of program folders. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables the end user to select a typical, compact, or custom setup. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that enables the end user to select one of the two standard setup types: Complete or Custom. |
|||||||
Basic MSI, InstallScript, InstallScript MSI |
Returns a formatted string composed of one or more character, numeric, or string values. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog that enables the end user to bring up a list of all SQL Servers available on the network. SQLBrowse2 supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog that lets an end user display a list of all database servers that are available on the network for the database technologies specified for a connection. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog that is used by the script to specify SQL login credentials. These credentials include the login ID and password. |
|||||||
InstallScript, InstallScript MSI |
Creates a dialog to specify a server to target. |
|||||||
InstallScript, InstallScript MSI |
Creates a login dialog that enables the targeted end user to specify which SQL Server should to be used for the current connection, as well as which login credential should be used. The dialog displays a combo box that contains a list of SQL Servers accessed through DSNs. The end user can type a server name in the combo box or click the Browse button next to the combo box; clicking this button displays a list of all SQL Servers that are available on the network. SQLServerSelectLogin2 supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Creates a login dialog that is used by the default script. It lets the targeted end user specify which SQL Server should be used for the current connection, as well as which login credential should be used. The dialog displays a combo box that contains a list of SQL Servers accessed through DSNs. The end user can type a server name in the combo box or click the Browse button next to the Server Name combo box; clicking this button displays a list of all SQL Servers that are available on the network. This function also optionally shows the connection name that is associated with the connection information. In addition, it optionally enables end users to specify which database catalog should be used for the current connection. |
|||||||
InstallScript, InstallScript MSI |
Creates a login dialog that is used by the default script. It lets the targeted end user specify which SQL Server should be used for the current connection, as well as which login credential should be used. The dialog displays a combo box that contains a list of SQL Servers accessed through DSNs. The end user can type a server name in the combo box or click the Browse button next to the Server Name combo box; clicking this button displays a list of all SQL Servers that are available on the network. This function also shows the connection name that is associated with the connection information. SQLServerSelectLogin2 supersedes this function. |
|||||||
InstallScript, InstallScript MSI |
Presents a dialog that displays welcome information. |
See Also
Dialog Customization Functions
Creating New Custom Dialogs in InstallScript and InstallScript MSI Projects
InstallShield 2016 Help LibraryMay 2017 |
Copyright Information | Flexera Software |