SQLRTGetDatabases

InstallShield 2016 » InstallScript Language Reference

Project • This information applies to the following project types:

InstallScript
InstallScript MSI

The SQLRTGetDatabases function returns a list of database catalogs that are available on the specified database server.

Note • If you want to call any built-in SQL-related function before the OnSQLServerInitialize event handler is called in an InstallScript project or the OnSQLLogin event handler is called in an InstallScript MSI project, call the SQLRTInitialize2 function first. To learn more, see Using the SQL Run-Time Functions in InstallScript and InstallScript MSI Projects.

Syntax

SQLRTGetDatabases( szConnection, szServer, bTrust, szUserName, szPassword );

Parameters

SQLRTGetDatabases Parameters

Parameter

Description

szConnection

Specifies the name of the connection that you created in the SQL Scripts view.

szServer

Specifies the SQL Server.

bTrust

Specifies the initial state of the radio buttons specifying login using Windows credentials vs. SQL Server credentials. When this is TRUE, the password and login ID fields are disabled. When it is FALSE, indicating that SQL Server credentials are to be used, the password and login fields are enabled.

Once the function returns, this parameter contains TRUE if the Windows credentials radio button was specified by the end user and FALSE if the SQL Server credentials radio was selected instead.

szUserName

Specifies the SQL Server login information.

szPassword

Specifies the password associated with a user account.

Return Values

Returns a list of the database catalogs that are available on the target database server.

See Also