ISWiSQLScript Object

InstallShield 2016

Project • This information applies to the following project types:

• Basic MSI
• DIM
• InstallScript
• InstallScript MSI

Project-specific differences are noted where appropriate.

ISWiSQLScript represents a SQL script file in the SQL Scripts explorer of the SQL Scripts view in InstallShield. You can retrieve an ISWiSQLScript object by using the ISWiSQLScripts collection.

Members

ISWiSQLScript Object Members

Name

Type

Description

AddSQLScriptError

Method

Creates and returns ISWiSQLScriptError objects.

AddSQLScriptReplacement

Method

Creates and returns ISWiSQLReplace objects.

Comments

Read-Write Property

This string property gets or sets any internal comments you want to include within your installation project. You can enter any notes regarding the script. These notes will be saved and used only within the installation project.

Component

Read-Write Property

This string property gets or sets the name of the component which is associated with the feature that is associated with the SQL script object.

Condition

Read-Write Property

Project • This property is available for the following project types:

• Basic MSI
• DIM
• InstallScript MSI

This property specifies the condition that is evaluated at run time to determine whether the SQL script should be run during installation or uninstallation. If the condition evaluates to true, the script is run.

This property corresponds with the condition that is entered in the Script Condition area of the Runtime tab for a SQL script in the SQL Scripts view.

DeleteSQLReplace

Method

Deletes an ISWiSQLReplace object.

DeleteSQLScriptError

Method

Deletes an ISWiSQLScriptError object.

ErrorHandling

Read-Write Property

Gets or sets one of the following values.

• esehAbort (2)—On error, abort the installation.
• esehGotoNextScript (0)—On error, go to the next script.
• esehGotoNextStatement (1)—On error, go to the next statement.

FullPath

Read-Write Property

This string property gets or sets the path of the .sql file associated with the SQL script object you want to execute by the installation.

InstallText

Read-Write Property

This string property gets or sets the status text when a script is run during install. This status text appears in the status message, which is displayed to the end-user while the script is running.

ISWiSQLScriptErrors

Read-Only Property

Returns the collection of ISWiSQLScriptErrors that are associated with this SQL script.

Name

Read-Write Property

This string property gets or sets the name of the SQL script object that you want to execute by the installation.

Order

Read-Write Property

This integer property gets or sets the order of execution of the script file.

RunOnInstall

Read-Write Property

This Boolean property specifies whether to schedule the execution of the SQL script during installation.

RunOnLogon

Read-Write Property

This Boolean property specifies whether to run the selected SQL script during login. This property corresponds with the Run Script During Login check box on the Runtime tab for a SQL script in the SQL Scripts view.

RunOnRollback

Read-Write Property

This Boolean property specifies whether to schedule the execution of the SQL script during rollback. This property corresponds with the Run Script During Rollback check box on the Runtime tab for a SQL script in the SQL Scripts view.

RunOnUninstall

Read-Write Property

This Boolean property specifies whether to schedule the execution of the SQL script during uninstallation.

UninstallText

Read-Write Property

This string property gets or sets the status text when a script is run during uninstall. This status text appears in the status message, which is displayed to the end-user while the script is running.

Version

Read-Write Property

This property gets or sets the version number for the SQL script file. For more information, see Specifying a Version Number for a SQL Script File.

InstallShield 2016 Help Library

August 2016

 Copyright Information | Flexera Software

Open topic with navigation