Patch Object

Windows Installer

Patch Object

The Patch object represents a unique instance of a patch that has been registered or applied.

The object can be instantiated with the Patch property as "WindowsInstaller.Installer.Patch(PatchCode, ProductCode, UserSid, Context)". For a machine context, the UserSid parameter must be an empty string. The ProductCode can be set to an empty string for patches that are registered only and not yet applied to any product. The ProductCode can be set to an empty string when only reading or updating a patch's source list information.

Methods

The Patch object defines the following methods.

Method Description

SourceListAddSource

Add a network or URL source to the source list.

SourceListAddMediaDisk

Add a disk to the set of registered disks.

SourceListClearSource

Remove a network or URL source from the source list.

SourceListClearMediaDisk

Remove a disk from the set of registered disks from the source list.

SourceListClearAll

Clears the complete source list of the specified type of sources.

SourceListForceResolution

Clears the last used source from the source list. This forces a source list resolution the next time the source is required.

 

Properties

The Patch object defines the following properties.

Property Access type Description

Context

Read-only

Context of this patch instance is an MSIINSTALLCONTEXT value. This is a read-only property.

MediaDisks

Read-only

Enumerates all the media disks for this patch instance. This is a read-only property.

PatchCode

Read-only

Returns the patch code. This is a read-only property.

PatchProperty

Read-only

Gets property information about a specific patch applied to a specific instance of the product. This is a read-only property.

ProductCode

Read-only

Returns the product code. This is a read-only property.

SourceListInfo

Read-only

Gets and sets the source information properties. This is a read or write property.

Sources

Read-only

Enumerates all the sources for this patch instance. This is a read-only property.

State

Read-only

Installation state of the patch. This is a read-only property.

UserSid

Read-only

Returns the User SID, under the account this patch instance is available. This is a read-only property.

 

Requirements

VersionWindows Installer 5.0 on Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer 3.0 or later on Windows Server 2003, Windows XP, and Windows 2000
DLLMsi.dll
IIDIID_IPatch is defined as 000C10A1-0000-0000-C000-000000000046

See Also

Windows Installer Scripting Examples

Send comments about this topic to Microsoft

Build date: 8/13/2009

© 2009 Microsoft Corporation. All rights reserved.