Edit

Share via


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.

Members

The Patch object has these types of members:

Methods

The Patch object has these methods.

Method Description
SourceListAddMediaDisk Add a disk to the set of registered disks.
SourceListAddSource Add a network or URL source to the source list.
SourceListClearAll Clears the complete source list of the specified type of sources.
SourceListClearMediaDisk Remove a disk from the set of registered disks from the source list.
SourceListClearSource Remove a network or URL source from the source list.
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 has these properties.

Property Description
Context
Context of this patch instance is an MSIINSTALLCONTEXT value.
MediaDisks
Enumerates all the media disks for this patch instance.
PatchCode
Returns the patch code.
PatchProperty
Gets property information about a specific patch applied to a specific instance of the product.
ProductCode
Returns the product code.
SourceListInfo
Gets and sets the source information properties. This is a read or write property.
Sources
Enumerates all the sources for this patch instance.
State
Installation state of the patch.
UserSid
Returns the User SID, under the account this patch instance is available.

 

Requirements

Requirement Value
Version
Windows Installer 5.0 on Windows Server 2012, Windows 8, 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
DLL
Msi.dll
IID
IID_IPatch is defined as 000C10A1-0000-0000-C000-000000000046

See also

Windows Installer Scripting Examples