SdLicense2Ex

InstallShield 2016 » InstallScript Language Reference

Project • This information applies to the following project types:

•

InstallScript

•

InstallScript MSI

The SdLicense2Ex 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) identified in the parameter szLicenseFile.

The end user can scroll up and down to read the agreement. The end user must select the upper option button for the Next button to become enabled, which allows the installation to continue. Because this is usually the first dialog that you would display, you might want to disable the Back button.

Syntax

SdLicense2Ex (byval string szTitle, byval string szOpt1, byval string szOpt2, byval string szLicenseFile, byval bool bLicenseAccepted, byval bool bRtf);

Parameters

SdLicense2Ex Parameters

Parameter

Description

szTitle

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

szOpt1

Specify the text to display in the static text field next to the upper option button. To display the default text ("I accept the terms of the license agreement"), pass a null string ("") in this parameter.

szOpt2

Specify the text to display in the static text field next to the lower option button. To display the default text ("I do not accept the terms of the license agreement"), 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.

bLicenseAccepted

Specify the option button that is selected by default. Pass one of the following predefined constants in this parameter:

•

TRUE—Specifies the upper option button as the default selection.

•

FALSE—Specifies the lower option button as the default selection.

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

SdLicense2Ex Return Values
Return Value	Description
NEXT	The end user selected the upper option button and the Next button.
BACK	The end user selected the Back button.
< ISERR_SUCCESS	The dialog could not be 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

SdLicense2Ex

InstallShield 2016 Help Library

May 2017