ISWiSuiteOperation Object (Advanced UI and Suite/Advanced UI)

InstallShield 2022 » Automation Interface » Advanced UI and Suite/Advanced UI

Project:This information applies to the following project types:

• Advanced UI
• Suite/Advanced UI

Edition:The Advanced UI project type is available in the InstallShield. The Suite/Advanced UI project type is available in the Premier edition of InstallShield. For information about the differences between these two project types, see Advanced UI Projects vs. Suite/Advanced UI Projects.

The ISWiSuiteOperation object represents an operation on a package.

Note that some ISWiSuiteOperation items are not applicable to all types of Advanced UI or Suite/Advanced UI package files.

Members

ISWiSuiteOperation Object Members

Name

Type

Type of Package File

Description

CmdLine

Read-Write String Property

.msi, .msp, .exe, InstallScript, Basic MSI project, InstallScript project

If applicable, gets or sets the command line that should be used to launch the target file whenever the Advanced UI or Suite/Advanced UI installation is running with a user interface. Do not include the name of the file in this property.

The value of this property can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this property, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

Enable

Read-Write Boolean Property

Support varies

Gets or sets a value to indicate whether an operation for a package is enabled.

ExitBehavior

Read-Write Integer Property

.exe

If a detection condition is still not met on a target system after the package has been run, either one of the following may be true:

• The executable file package was not run successfully.
• The detection conditions that were specified for the package were not accurate.

For example, a detection condition may indicate that the executable file needs to be launched if a particular file does not exist on the target system. If the file is still missing even after the Advanced UI or Suite/Advanced UI installation has run the executable file package, it is possible that the condition was created erroneously.

The ExitBehavior property indicates the behavior that should occur if one or more of the detection conditions still indicate that the package needs to be launched. Available options are:

• epseDetectPrompt (0)—Ask whether to continue the setup.

The Advanced UI or Suite/Advanced UI installation displays a message box that prompts the end user to specify whether the Advanced UI or Suite/Advanced UI installation should continue.

• epseDetectAbort (1)—Abort the setup.

The Advanced UI or Suite/Advanced UI installation ends without proceeding further.

• epseDetectIgnore (2)—Continue the setup.

The Advanced UI or Suite/Advanced UI installation essentially ignores the executable file’s unmet condition and proceeds to the next package in the installation (if one is required).

ForceApplicationShutdown

Read-Write Boolean Property

.appx

If the selected sideloading app package (or any package that depends on this package) is in use at installation run time, you can require that the processes that are associated with the package are forced to shut down so that registration can proceed. Use this property to indicate whether you want to force application shutdown in that scenario.

RebootCode

Read-Write String Property

.exe

If the selected package requires that the target system be restarted after the product is installed, this property gets or sets one or more return codes. If multiple return codes exist, each one separated by a comma.

For more information on Advanced UI or Suite/Advanced UI packages that require a restart, see Restarting a Target System for an Advanced UI or Suite/Advanced UI Package.

RebootRequest

Read-Write String Property

.msi,
.msp,
.exe,
InstallScript,
Basic MSI project,
InstallScript project

The installation of an Advanced UI or Suite/Advanced UI package may require that the target system be restarted, as described in Restarting a Target System for an Advanced UI or Suite/Advanced UI Package.

The RebootRequest property indicates the behavior that should occur if the package requires that a target system be restarted. Available options are:

• epsrDetectExit (1)—Allow the machine to reboot.
• epsrDetectReboot (2)—Prompt, then exit or reboot the machine.
• epsrDetectIgnore (4)—Ignore the reboot request.
• epsrAlwaysRebootPrompt (8)—Always prompt, then exit or reboot the machine.
• epsrAlwaysRebootSilent (16)—Always reboot the machine.
• epsrDetectDelay (32)—Delay the prompt, then exit or reboot the machine.

Silent

Read-Write String Property

.msi, .msp, .exe, InstallScript, Basic MSI project, InstallScript project

If applicable, gets or sets the command line that should be used to launch the target file whenever the Advanced UI or Suite/Advanced UI installation is running silently (that is, without a user interface). Do not include the name of the file in this property.

The value of this property can include one or more formatted expressions that contain property names, environment variable references, and other special strings; at run time, the installation expands the values of these expressions. To learn about the syntax that is available for these expressions, see Using Formatted Expressions that Advanced UI and Suite/Advanced UI Installations Resolve at Run Time.

For more information, including valid types of entries for this property, see Passing Command-Line Parameters to a Package in an Advanced UI or Suite/Advanced UI Installation.

Target

Read-Write String Property

Support varies

Gets or sets the file in the package that the Advanced UI or Suite/Advanced UI installation should invoke.

This property is available in the following scenarios:

• When the Type property is esotInstall (1) and the type of package file is .msi, .msp, .exe, and InstallScript packages
• When the Type property is esotRemove (2), esotRepair (3), or esotModify (4), and the type of package file is .exe packages

Type

Read-only String Property

Support varies

Gets the type of operation. Available options are:

• esotInstall (1)—The package is launched as a first-time installation.

This operation is available for the following types of package files: .msi, .msp, .exe, .appx, InstallScript, Basic MSI project, and InstallScript project.

• esotRemove (2)—The product that the package installed is removed.

This operation is available for the following types of package files: .msi, .exe, .appx, InstallScript, Basic MSI project, and InstallScript project.

• esotRepair (3)—The product that the package installed is repaired.

This operation is available for the following types of package files: .msi, .exe, InstallScript, Basic MSI project, and InstallScript project.

• esotModify (4)—The package is launched in maintenance mode to enable end users to install, remove, or modify the product.

This operation is available for the following types of package files: .msi, .msp, .exe, InstallScript, Basic MSI project, and InstallScript project.

Applies To

• ISWiSuitePackage