Deployment Tools Foundation
Installer Class
Provides static methods for installing and configuring products and patches.
Declaration Syntax| C# | Visual Basic | Visual C++ |
public static class Installer
Public NotInheritable Class Installer
public ref class Installer abstract sealed
Members| All Members | Methods | Properties | |||
|
|
|
|
|||
| Icon | Member | Description |
|---|---|---|
|
AdvertiseProduct(String, Boolean, String, Int32) |
Advertises a product to the local computer.
|
|
|
AdvertiseScript(String, Int32, Boolean) |
Copies an advertise script file to the local computer.
|
|
|
ApplyMultiplePatches(IList<(Of <(String>)>), String, String) |
Applies one or more patches to products that are eligible to receive the patch.
For each product listed by the patch package as eligible to receive the patch, ApplyPatch invokes
an installation and sets the PATCH property to the path of the patch package.
|
|
|
ApplyPatch(String, String) |
For each product listed by the patch package as eligible to receive the patch, ApplyPatch invokes
an installation and sets the PATCH property to the path of the patch package.
|
|
|
ApplyPatch(String, String, InstallType, String) |
For each product listed by the patch package as eligible to receive the patch, ApplyPatch invokes
an installation and sets the PATCH property to the path of the patch package.
|
|
|
ConfigureFeature(String, String, InstallState) |
Configures the installed state for a product feature.
|
|
|
ConfigureProduct(String, Int32, InstallState, String) |
Installs or uninstalls a product.
|
|
|
DetermineApplicablePatches(String, array<String>[]()[], InapplicablePatchHandler) |
Determines which patches apply to a specified product MSI and in what sequence.
|
|
|
DetermineApplicablePatches(String, array<String>[]()[], InapplicablePatchHandler, String, UserContexts) |
Determines which patches apply to a specified product and in what sequence. If
the product is installed, this method accounts for patches that have already been applied to
the product and accounts for obsolete and superceded patches.
|
|
|
EnableLog(InstallLogModes, String) |
Enables logging of the selected message type for all subsequent install sessions in
the current process space.
|
|
|
EnableLog(InstallLogModes, String, Boolean, Boolean) |
Enables logging of the selected message type for all subsequent install sessions in
the current process space.
|
|
|
ExtractPatchXmlData(String) |
Extracts information from a patch that can be used to determine whether the patch
applies on a target system. The method returns an XML string that can be provided to
DetermineApplicablePatches(String, array<String>[]()[], InapplicablePatchHandler, String, UserContexts)
instead of the full patch file.
|
|
|
GenerateAdvertiseScript(String, String, String, Int32) |
Generates an advertise script. The method enables the installer to write to a
script the registry and shortcut information used to assign or publish a product.
|
|
|
GenerateAdvertiseScript(String, String, String, Int32, ProcessorArchitecture, Boolean) |
Generates an advertise script. The method enables the installer to write to a
script the registry and shortcut information used to assign or publish a product.
|
|
|
GetErrorMessage(Int32) |
Gets a Windows Installer error message in the system default language.
|
|
|
GetErrorMessage(Int32, CultureInfo) |
Gets a Windows Installer error message in a specified language.
|
|
|
GetErrorMessage(Record) |
Gets a formatted Windows Installer error message in the system default language.
|
|
|
GetErrorMessage(Record, CultureInfo) |
Gets a formatted Windows Installer error message in a specified language.
|
|
|
GetFileHash(String, array<Int32>[]()[]) |
Gets a 128-bit hash of the specified file.
|
|
|
GetFileLanguage(String) |
Gets the language string of the path specified using the format that the installer
expects to find them in in the database.
|
|
|
GetFileVersion(String) |
Gets the version string of the path specified using the format that the installer
expects to find it in in the database.
|
|
|
GetPatchFileList(String, IList<(Of <(String>)>)) |
[MSI 4.0] Gets the list of files that can be updated by one or more patches.
|
|
|
GetProductInfoFromScript(String) |
Gets product information for an installer script file.
|
|
|
GetShortcutTarget(String) |
Examines a shortcut and returns its product, feature name, and component if available.
|
|
|
InstallMissingComponent(String, String, InstallState) |
Installs files that are unexpectedly missing.
|
|
|
InstallMissingFile(String, String) |
Installs files that are unexpectedly missing.
|
|
|
InstallProduct(String, String) |
Opens an installer package and initializes an install session.
|
|
|
NotifySidChange(String, String) |
[MSI 3.1] Migrates a user's application configuration data to a new SID.
|
|
|
OpenPackage(String, Boolean) |
Opens an installer package for use with functions that access the product database and install engine,
returning an Session object.
|
|
|
OpenPackage(Database, Boolean) |
Opens an installer package for use with functions that access the product database and install engine,
returning an Session object.
|
|
|
OpenProduct(String) |
Opens an installer package for an installed product using the product code.
|
|
|
ProcessAdvertiseScript(String, String, Boolean, Boolean) |
Processes an advertise script file into the specified locations.
|
|
|
ProvideAssembly(String, String, InstallMode, Boolean) |
Gets the full path to a Windows Installer component containing an assembly. This method prompts for a source and
increments the usage count for the feature.
|
|
|
ProvideComponent(String, String, String, InstallMode) |
Gets the full component path, performing any necessary installation. This method prompts for source if
necessary and increments the usage count for the feature.
|
|
|
ProvideQualifiedComponent(String, String, InstallMode, String) |
Gets the full component path for a qualified component that is published by a product and
performs any necessary installation. This method prompts for source if necessary and increments
the usage count for the feature.
|
|
RebootInitiated |
Indicates whether a system reboot has been initiated after running an installation or configuration operation.
|
|
|
RebootRequired |
Indicates whether a system reboot is required after running an installation or configuration operation.
|
|
|
ReinstallFeature(String, String, ReinstallModes) |
Reinstalls a feature.
|
|
|
ReinstallProduct(String, ReinstallModes) |
Reinstalls a product.
|
|
|
RemovePatches(IList<(Of <(String>)>), String, String) |
Removes one or more patches from a single product. To remove a patch from
multiple products, RemovePatches must be called for each product.
|
|
|
SetExternalUI(ExternalUIHandler, InstallLogModes) |
Enables an external user-interface handler. This external UI handler is called before the
normal internal user-interface handler. The external UI handler has the option to suppress
the internal UI by returning a non-zero value to indicate that it has handled the messages.
|
|
|
SetExternalUI(ExternalUIRecordHandler, InstallLogModes) |
[MSI 3.1] Enables a record-based external user-interface handler. This external UI handler is called
before the normal internal user-interface handler. The external UI handler has the option to suppress
the internal UI by returning a non-zero value to indicate that it has handled the messages.
|
|
|
SetInternalUI(InstallUIOptions, IntPtr%) |
Enables the installer's internal user interface. Then this user interface is used
for all subsequent calls to user-interface-generating installer functions in this process.
|
|
|
SetInternalUI(InstallUIOptions) |
Enables the installer's internal user interface. Then this user interface is used
for all subsequent calls to user-interface-generating installer functions in this process.
The owner of the user interface does not change.
|
|
|
UseFeature(String, String, InstallMode) |
increments the usage count for a particular feature and returns the installation state for
that feature. This method should be used to indicate an application's intent to use a feature.
|
|
|
VerifyPackage(String) |
Verifies that the given file is an installation package.
|
|
|
Version |
Gets the current version of the installer.
|
Inheritance Hierarchy| Object | |
|
Installer |