ISWiSQLConnection Object

InstallShield 2016 » Automation Interface

Project • This information applies to the following project types:

•

Basic MSI

•

DIM

•

InstallScript

•

InstallScript MSI

ISWiSQLConnection represents a SQL Server connection in the SQL Scripts view of the InstallShield interface. You can retrieve an ISWiSQLConnection object by using the ISWiSQLConnections collection.

Members

ISWiSQLConnection Object Members
Name	Type	Description
AddSQLRequirement	Method	Call the AddSQLRequirement method to target specific server versions and determine whether the SQL Server meets your application's minimum requirements.
AddSQLScript	Method	Call the AddSQLScript method to add a new script file to a SQL connection. Note • The AddSQLScript method generates the ISSQLScriptFile table key with a name such as SQLScript1, SQLScript2, or SQLScript3. If you have multiple SQL script files in your project, it may be difficult to distinguish one from the other with this naming convention. Therefore, if you want to be able to specify the key, use the AddSQLScriptEx method.
AddSQLScriptEx	Method	Call the AddSQLScriptEx method to add a new script file to a SQL connection, and generate a valid name from the passed string.
Authentication	Read-Write Property	This string gets or sets the authentication mode when connecting to a SQL Server.
Comments	Read-Write Property	This string property gets or sets any internal comments you want to include within your installation project.
Database	Read-Write Property	This string gets or sets the database name. At runtime, the installation uses this as the default database for installing the SQL script files contained in this connection. This value can be a property. Using a property allows you to dynamically set the name of this database at runtime.
DeleteSQLScript	Method	Call the DeleteSQLScript method to remove a SQL script file from a SQL Connection in the InstallShield interface.
GetDatabaseServer	Method	The GetDatabaseServer method returns an ISWiSQLDatabaseServer object.
InsertSQLScript	Method	Call the InsertSQLScript method to insert an existing script file to a SQL Connection in the InstallShield interface.
Name	Read-Write Property	This string property gets or sets the connection name. Type an internal name used to uniquely identify this connection in the setup project.
Order	Read-Write Property	This integer property gets or sets the connection order.
Password	Read-Write Property	This string gets or sets the password when you choose to connect to a server using SQL Server authentication.
RemoveSQLRequirement	Method	Removes a specified SQL requirement from the target product.
SelectDatabaseServer(Name As String) As Boolean	Read-Write Property	This string gets or sets the selected database server name. At runtime, the installation will establish a connection and perform specified requirement checks on the designated database servers based on the sequence of the servers as they are listed.
Server	Read-Write Property	This string gets or sets the server name. At runtime, the installation uses this server name to connect to a SQL Server. This server will be used to install the SQL scripts contained within this connection. This value can be a property. Using a property allows you to dynamically set the name of this server at runtime. You must use the [Property] notation.
UserName	Read-Write Property	This string gets or sets the user name when you choose to connect to a server using SQL Server authentication.

Applies To

•

ISWiProject

Open topic with navigation

ISWiSQLConnection Object

InstallShield 2016 Help Library

August 2016