SQLServerLogin

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The SQLServerLogin function creates a dialog that is used by the script to specify SQL login credentials. These credentials include the login ID and password.

This function is in the SQLRT.obl file for InstallScript projects, and in the SQLCONV.obl file for InstallScript MSI projects. If you are using the SQL Scripts view in InstallShield, the appropriate file is automatically added to your linker settings. However, if you are not using this view, add the appropriate file to your linker settings: On the Build menu, click Settings, and then add it to the Libraries (.obl) box.

Syntax

SQLServerLogin( szMsg, svUser, svPassword );

Parameters

SQLServerLogin Parameters

Parameter

Description

szMsg

Specifies the message to display in the dialog. To display the default instructions for this dialog, pass a null string (“”) in this parameter.

svUser

Specifies the default string to display in the Login ID edit box. Once the dialog function returns, this parameter contains the Login ID that the end user entered in the edit box. This information is only pertinent if the end user selected to use SQL Login instead of Windows credentials.

svPassword

Specifies the default string to display in the Password edit field. Once the dialog function returns, this parameter contains the password that the end user entered in the edit field. This information is only pertinent if the end user selected to use SQL Login instead of Windows credentials.

Return Vaues

SQLServerLogin Return Values

Return Value

Description

NEXT

The end user selected the Next button.

BACK

The end user selected the Back button.

< ISERR_SUCCESS

The dialog could not be displayed.