InstallShield 2016 » InstallScript Language Reference
Project • This information applies to the following project types:
| • | InstallScript |
| • | InstallScript MSI |
The SetupType function displays a dialog that enables the end user to select one of the three standard setup types: Typical, Compact, or Custom. These setup options are displayed with standard description text. If you want to add other setup types or change the displayed setup type names or descriptions, call SdSetupTypeEx instead.
Caution • If an end user returns to the Setup Type dialog after using a feature dialog to select and deselect features associated with the selected setup type, those choices are lost. This occurs because the SetupType function automatically resets the default feature selections for the selected setup type each time it is called.
Syntax
SetupType ( szTitle, szMsg, szReserved, nType, nReserved );
Parameters
|
Parameter |
Description |
|||||||||
|
szTitle |
Specifies the title of this dialog. To display the default title Setup Type, pass a null string ("") in this parameter. |
|||||||||
|
szMsg |
Specifies the message you want to display at the top of the dialog. To display the default instructions for this dialog, pass a null string ("") in this parameter. |
|||||||||
|
szReserved |
Pass a null string ("") in this parameter—no other value is allowed. |
|||||||||
|
nType |
Specifies the default setup type when the dialog is opened. Pass one of the following predefined constants in this parameter:
|
|||||||||
|
nReserved |
Pass zero in this parameter. No other value is allowed. |
Return Values
|
Return Value |
Description |
|
TYPICAL (301) |
Indicates that the end user selected the Typical setup type. |
|
COMPACT (302) |
Indicates that the end user selected the Compact setup type. |
|
CUSTOM (303) |
Indicates that the end user selected the Custom setup type. |
|
BACK (12) |
Indicates that the end user clicked the Back button. |
Additional Information
| • | In an InstallScript project, if you do not display a setup type dialog, your script must do one of the following: |
| • | Select a setup type. |
| • | Call a feature selection dialog function such as SdFeatureTree. |
| • | Directly select features. |
| • | 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. |
See Also
InstallShield 2016 Help LibraryMay 2017 |
Copyright Information | Flexera Software |