SdFinish

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

•

InstallScript

•

InstallScript MSI

The SdFinish function displays a dialog to inform the end user that the installation is complete and to provide information or options. The SdFinish dialog displays up to two messages and two check box selection options. For example, you could offer the end user the option of either viewing a README file or launching the application.

To insert the product name into the messages and check box descriptions, use the place holder %P in the strings passed in szMsg1, szMsg2, szOpt1, and szOpt2.

Note: SdFinish has no option to terminate the setup and reboot the end user's computer. When SdFinish returns, the setup continues to execute. To provide the end user with the option to reboot, call SdFinishReboot instead.

Syntax

SdFinish ( szTitle, szMsg1, szMsg2, szOpt1, szOpt2, bvOpt1, bvOpt2 );

Parameters

SdFinish Parameters
Parameter	Description
szTitle	Specifies the title of the dialog. To display the default title (“Setup Complete”), pass a null string (“”) in this parameter.
szMsg1	Specifies the message to display at the top of the dialog. To display the default instructions, which inform the user that the installation is complete, pass a null string (“”) in this parameter.
szMsg2	Specifies the message to display at the bottom of the dialog. To display the default instructions (“Click Finish to complete Setup”), pass a null string (“”) in this parameter.
szOpt1	Specifies the text to display beside the first check box. Pass a null string (“”) in this parameter to hide the check box.
szOpt2	Specifies the text to display beside the second check box. Pass a null string (“”) in this parameter to hide the check box.
bvOpt1	Returns the selection state (TRUE or FALSE) of the first check box.
bvOpt2	Returns the selection state (TRUE or FALSE) of the second check box.

Return Values

SdFinish Return Values
Return Value	Description
NEXT (1)	Indicates that the Finish button was clicked.

Note: Because SdFinish announces the end of the installation, the Back button is disabled.

Additional Information

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.

SdFinish

InstallShield 2014 Help Library

May 2014