Welcome

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The Welcome function displays a dialog that welcomes the end user.

In a procedural script, you must call SdProductName before calling Welcome so that InstallShield can insert the product name into the first paragraph of message text in the Welcome dialog. In an event-based script, SdProductName is called automatically, with the PRODUCT_NAME string entry as its argument, before the Begin event. If you do not pass a product name using SdProductName, InstallShield cannot insert the product name but inserts extra spaces instead.

Syntax

Welcome ( szTitle, nReserved );

Parameters

Welcome Parameters

Parameter

Description

szTitle

Specifies the title of this dialog. To display the default title Welcome, pass a null string ("") in this parameter.

nReserved

Pass 0 in this parameter.

Return Values

Welcome Return Values

Return Value

Description

NEXT (1)

Indicates that the end user clicked the NEXT button.

BACK (12)

Indicates that the end user clicked the BACK button.

< 0

Indicates that Welcome failed to display the dialog.

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.

See Also