EnterLoginInfo

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types.

InstallScript
InstallScript MSI

The EnterLoginInfo function displays a dialog that enables the end user to specify a user name and password. Note that the dialog does not validate or use the specified information. In addition, the dialog does not perform any error checking for the specified information.

The EnterLoginInfo dialog is typically used to let the end user specify a network user name and password. The SdLogonUserInformation dialog is similar to the EnterLoginInfo dialog, but the SdLogonUserInformation dialog provides additional options. If your installation needs to obtain information to log into a SQL Server, SQLServerLogin offers additional functionality.

Syntax

EnterLoginInfo (byval string szMsg, byref string svUser, byref string svPassword);

Parameters

EnterLoginInfo Parameters

Parameter

Description

szMsg

Specifies the static text to be displayed in the dialog. To display the default text, pass a null string ("") in this parameter.

svUser

Specifies the default value that is initially displayed in the User Name box when the function is called, and specifies the string that the end user specified when the function returns.

The dialog does not allow more than 255 characters to be entered in the User Name box.

svPassword

Specifies the default value that is initially displayed in the Password box when the function is called, and specifies the string that the end user specified when the function returns.

The dialog does not allow more than 255 characters to be entered in the Password box.

Return Values

EnterLoginInfo Return Values

Return Value

Description

>= ISERR_SUCCESS

The function was successful.

< ISERR_SUCCESS

The function was not successful.

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