EnterPassword

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The EnterPassword function displays a dialog that queries the end user for a password; the characters that the end user types in the edit box are displayed as asterisks (*).

Note: To check the returned password, you can call FeatureValidate, as is done in the default code for the OnCheckMediaPassword event handler function.

Syntax

EnterPassword ( szMsg, szDefault, svResult );

Parameters

EnterPassword Parameters

Parameter

Description

szMsg

Specifies a message to display in the dialog. This text is considered a static control. To display the default instructions for this dialog, pass a null string ("") in this parameter.

szDefault

Specifies the text that is initially displayed in the edit box.

svResult

Returns the text that the end user enters in the edit box.

Return Values

EnterPassword Return Values

Return Value

Description

NEXT

Indicates that the user clicked the Next button.

BACK

Indicates that the user clicked the Back button.

< ISERR_SUCCESS

Indicates that 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.