ISWiSuiteCondition 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 ISWiSuiteCondition object represents the following types of conditions:

•

Exit condition (used for the Condition property of the ISWiSuiteExitCondition object)

•

Feature condition (used for the Condition property of the ISWiSuiteFeature object)

•

Detection condition (used for the DetectionCondition property of the ISWiSuitePackage object)

•

Eligibility condition (used for the EligibleCondition property of the ISWiSuitePackage object)

The ISWiSuiteCondition object can also exist in the Conditions collection of an All, Any, or None condition group.

To add or remove conditions from a condition group, call AddCondition, AddGroup, AddExtensionCondition, or DeleteCondition.

Members

ISWiSuiteCondition Object Members

Name	Type	Description
AddCondition	Method	Adds a condition to a condition group.
AddExtensionCondition	Method	Adds an extension condition to a condition group.
AddGroup	Method	Adds an All, Any, or None operator to a setting for a condition group.
AddParameter	Method	Adds a parameter for an extension condition.
ChangeGroupType	Method	Changes the All, Any, or None operator in a condition group.
DeleteCondition	Method	Deletes a condition object.
DeleteParameter	Method	Deletes a parameter for an extension condition.
ISWiSuiteConditionParameters	Collection	Contains all of the settings for a conditional statement.
ISWiSuiteConditions	Collection	Contains all of the conditional statements under a condition group.
Move	Method	Moves a condition or a condition group within a condition tree.
Name	String Property: Read-Write for Extension Conditions; Read-only for all other conditions	For extension conditions: Gets or sets the part of the name of the DLL entry points. For other condition types: Gets the name of the condition.
Resource	Read-Write String Property	Gets or sets the source of the condition. For extension conditions, the value of this property is set to the name of the DLL file. For the other types of built-in conditions, the value of this property is read-only.
Type	Read-only Integer Property	Gets the type of condition, condition group, or condition check. Available options are: • esctAll (0)—An All condition group operates like a logical AND operation. All of the conditions that are in the All group must evaluate to true in order for the condition group to evaluate to true. • esctAny (1)—An Any condition group operates like a logical OR operation. If any of the conditions that are in the Any group evaluate to true, the entire condition group evaluates to true. If none of the conditions that are in the Any group evaluate to true, the entire condition group evaluates to false. • esctNone (2)—A None condition group operates like a logical NOR operation. If none of the conditions that are in the None group evaluate to true, the entire condition group evaluates to true. If any of the conditions that are in the None condition group evaluate to true, the entire condition group evaluates to false. Note that if the None condition group consists of only one conditional statement, it operates like a logical NOT operation. • esctBuiltin (11)—A built-in condition check has one or more subsettings. Examples of the built-in condition checks are Platform, File Exists, Eligible Package, and Feature Operation. • esctExtension (21)—An extension condition uses a C/C++ DLL that you created to implement your own custom condition that checks target systems for factors that the other types of condition checks do not evaluate. To identify group conditions, use the following: pCondition.Type < 10

Applies To

•

ISWiSuiteExitCondition

•

ISWiSuiteFeature

•

ISWiSuitePackage

See Also

Building Conditional Statements in Advanced UI and Suite/Advanced UI Projects

Types of Condition Checks in Advanced UI and Suite/Advanced UI Projects

Creating a Custom Condition for an Advanced UI or Suite/Advanced UI Installation