ISWiMsiPatchSequence Object

InstallShield 2023 » Automation Interface

Project:This information applies to the following project types:

Basic MSI
InstallScript MSI

Contains all the information that the installer requires to determine the sequence of application of a small update patch relative to all other patches.

Members

ISWiMsiPatchSequence Object Members

Name

Type

Description

FamilyName

Read-Write Property

Gets the patch family name. Patches in the same patch family that target the same product version are sorted by the values in the Sequence column. The patches within the patch family are applied to the target product in the order of increasing sequence. The PatchFamily is also used to determine which patches are to be superseded. A patch may be listed in multiple rows and belong to multiple patch families if it applies to more than one product or includes multiple fixes.

The Windows Installer does not interpret the PatchFamily value in any way other than comparisons for equality against other PatchFamily values. A PatchFamily value must be unique within the ProductCode targeted by the set of patches. In the complex patching scenarios the PatchFamily identifier may need to be globally unique.

Sequence

Read-Write Property

Gets or Sets the sequence of this patch within the specified PatchFamily. The value in Sequence is expressed in the format of Version data. The value contains between 1 and 4 fields and each field has a range of 0 to 65535. Members of PatchFamily are sorted and applied to the target product in the order of increasing Sequence values. For example, the following six values are increasing: 1, 1.1, 1.2, 2.01, 2.01.1, 2.01.1.1.

Supersede

Read-Write Property

Set this Boolean property to True to indicate that the small update patch supersedes the updates provided by all patches with lesser Sequence values in the same PatchFamily.

Target

Read-Write Property

Gets or Sets target product code. A value in this property is optional. If a product code GUID is set in this property and the patch is being applied to the specified product, the patch is sorted and applied as a member of the specified PatchFamily. If a product code GUID is set in this field and the patch is not being applied to the product specified by ProductCode, this row is ignored. If the value in ProductCode is NULL, the patch is sorted and applied as a member of PatchFamily for all targets of the patch regardless of the product code.

A patch can have multiple rows in the same PatchFamily and a different ProductCode for each product targeted by the patch. One row for the PatchFamily can specify NULL for ProductCode. If the target product matches a row with a non-NULL ProductCode, the installer uses the matching row and ignores the row with the NULL ProductCode. If none of the specified product codes match the target, the patch is sorted and applied as a member of PatchFamily for all targets of the patch regardless of the product code.

Applies To

ISWiProject