SdSetupCompleteError

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The SdSetupCompleteError function displays a dialog to inform the end user that the installation was interrupted before it could be completed. It also informs the end user that the product has not been installed and that the target system was not modified.

Syntax

SdSetupCompleteError ( szTitle, szMsg1, szMsg2 );

Parameters

SdSetupCompleteError Parameters

Parameter

Description

szTitle

Specifies the title of the dialog. To display the default title (“InstallShield Wizard Completed”), 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 end user that the installation has been interrupted and the product has not been installed, 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 exit the wizard”), pass a null string ("") in this parameter.

Return Values

SdSetupCompleteError Return Values

Return Value

Description

NEXT (1)

Indicates that the Finish button was clicked.

Additional Information

If you write your own procedural script, that is, a program/endprogram block, you can use the SdSetupCompleteError function to display a dialog if the end user cancels the installation. If you are using the default script event model, you do not need to call this function.

Because SdSetupCompleteError indicates that the installation was interrupted and cannot be completed, the Back button is disabled.

The SdSetupCompleteError dialog is a variation of the SdFinish dialog. In a silent response file (.iss), the SdSetupCompleteError dialog is referred to as SdFinish.

See Also