SdLicenseEx

InstallShield 2019 » InstallScript Language Reference

Project • This information applies to the following project types:

•

InstallScript

•

InstallScript MSI

The SdLicenseEx function 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 format file (.rtf).

The end user can scroll up and down to read the agreement. The end user must choose either the Yes, No, or—if enabled—Back button. Because this is usually the first dialog that you would display, you might want to disable the Back button. If the user selects Yes, the installation continues. If the user selects No, the installation displays the ExitSetup dialog.

Syntax

SdLicenseEx (byval string szTitle, byval string szMsg, byval string szQuestion, byval string szLicenseFile, byval bool bRtf);

Parameters

SdLicenseEx Parameters

Parameter

Description

szTitle

Specify the title of the dialog. To display the default title (“Software License Agreement”), pass a null string (“”) in this parameter.

szMsg

Specify the message to display in the static text field above the multi-line edit field. To display the default instructions, pass a null string (“”) in this parameter.

szQuestion

Specify the text to display in the static text field below the multi-line edit field. You would likely place a question here, to which the user should respond by selecting either Yes and No. To display the default instructions, pass a null string (“”) in this parameter.

szLicenseFile

Specify the name of the ANSI text file or .rtf file that contains the license agreement. This file must be added to the appropriate language folder in the Support Files/Billboards view. You can also specify szLicenseFile by entering the fully qualified name, in quotation marks, or a UNC path.

Note • If you are using an .rtf file, the file size limit is 16 MB.

bRtf

Indicate whether to use the dialog with the rich text edit control. Available options are:

•

TRUE—Use the rich text edit control. If you select this option, the file that you specify for szLicenseFile must be an .rtf file.

•

FALSE—Use the standard edit control. If you select this option, the file that you specify for szLicenseFile must be a .txt file.

Return Values

SdLicenseEx Return Values
Return Value	Description
YES (1)	The end user selected the Yes button.
BACK (12)	The end user selected the Back button.

Note • This function cannot return NO because if the end user clicks the No button, the ExitSetup dialog is displayed.

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.

Open topic with navigation

SdLicenseEx

InstallShield 2019 Help Library

April 2019