SdPatchWelcome

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to InstallScript MSI projects.

The SdPatchWelcome function creates a dialog that displays a welcome message to the end user during a patch installation.

Syntax

SdPatchWelcome ( szTitle, szMsg );

Parameters

SdPatchWelcome Parameters

Parameter

Description

szTitle

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

szMsg

Specifies the message to display in the Welcome dialog. To include in this message the product name set by a previous call to SdProductName, insert the place holder %P anywhere in the message string. When the message is displayed, %P is replaced by the product name. To display the default welcome message, pass a null string ("") in this parameter.

Return Values

SdPatchWelcome Return Values

Return Value

Description

NEXT (1)

Indicates that the Next button was clicked.

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.
If you call SdPatchWelcome but SD_NDLG_PATCHWELCOME—its dialog resource (12059)—cannot be found in the _isres.dll file of the installation, SdWelcome is called automatically instead of SdPatchWelcome to display a dialog that is similar to the SdPatchWelcome dialog. In this case, the values for szTitle and szMsg are passed to the SdWelcome function, or custom strings are used if szTitle and szMsg are blank. This occurs only if you are patching a product whose installation was created with InstallShield Developer 7, or the dialog template has been removed manually.

Note that when this occurs, the dialog uses the same template as SdWelcome; thus, any changes to the SdWelcome dialog template affect the SdPatchWelcome dialog as well.

Note that in this scenario, silent mode is not supported, and it does not work correctly.

See Also