Skip to main content

WixToolset.Dtf.WindowsInstaller namespace

Classes

ClassDescription
BadQuerySyntaxExceptionA bad SQL query string was passed to «see M:WixToolset.Dtf.WindowsInstaller.Database.OpenView(System.String,System.Object[])» or «see M:WixToolset.Dtf.WindowsInstaller.Database.Execute(System.String,System.Object[])» .
ColumnCollectionCollection of column information related to a «see T:WixToolset.Dtf.WindowsInstaller.TableInfo» or «see T:WixToolset.Dtf.WindowsInstaller.View» .
ColumnInfoDefines a single column of a table in an installer database.
ComponentInfoProvides access to information about a component within the context of an installation session.
ComponentInfoCollectionAccessor for information about components within the context of an installation session.
ComponentInstallationRepresents an instance of a registered component.
CustomActionAttributeMarks a method as a custom action entry point.
CustomActionDataContains a collection of key-value pairs suitable for passing between immediate and deferred/rollback/commit custom actions.
DatabaseAccesses a Windows Installer database.
FeatureInfoProvides access to information about a feature within the context of an installation session.
FeatureInfoCollectionAccessor for information about features within the context of an installation session.
FeatureInstallationRepresents an instance of a feature of an installed product.
InstallationSubclasses of this abstract class represent a unique instance of a registered product or patch installation.
InstallationPartSubclasses of this abstract class represent an instance of a registered feature or component.
InstallCanceledExceptionUser Canceled the installation.
InstallerProvides static methods for installing and configuring products and patches.
InstallerExceptionBase class for Windows Installer exceptions.
InstallerHandleBase class for Windows Installer handle types (Database, View, Record, SummaryInfo).
InvalidHandleExceptionA method was called on an invalid installer handle. The handle may have been already closed.
MergeExceptionA failure occurred when executing «see M:WixToolset.Dtf.WindowsInstaller.Database.Merge(WixToolset.Dtf.WindowsInstaller.Database,System.String)» . The exception may contain details about the merge conflict.
PatchInstallationThe Patch object represents a unique instance of a patch that has been registered or applied.
ProductInstallationRepresents a unique instance of a product that is either advertised, installed or unknown.
RecordThe Record object is a container for holding and transferring a variable number of values. Fields within the record are numerically indexed and can contain strings, integers, streams, and null values. Record fields are indexed starting with 1. Field 0 is a special format field.
SessionThe Session object controls the installation process. It opens the install database, which contains the installation tables and data.
SourceListA list of sources for an installed product or patch.
SourceMediaListA list of source media for an installed product or patch.
SummaryInfoProvides access to summary information of a Windows Installer database.
TableCollectionContains information about all the tables in a Windows Installer database.
TableInfoDefines a table in an installation database.
Transaction[MSI 4.5] Handle to a multi-session install transaction.
ViewA View represents a result set obtained when processing a query using the «see M:WixToolset.Dtf.WindowsInstaller.Database.OpenView(System.String,System.Object[])» method of a «see P:WixToolset.Dtf.WindowsInstaller.View.Database» . Before any data can be transferred, the query must be executed using the «see M:WixToolset.Dtf.WindowsInstaller.View.Execute(WixToolset.Dtf.WindowsInstaller.Record)» method, passing to it all replaceable parameters designated within the SQL query string.

Structures

StructureDescription
InstallCostRepresents a per-drive disk space cost for an installation.
MediaDiskRepresents a media disk source of a product or a patch.
ShortcutTargetHolds information about the target of a shortcut file.
ValidationErrorInfoContains specific information about an error encountered by the «see M:WixToolset.Dtf.WindowsInstaller.View.Validate(WixToolset.Dtf.WindowsInstaller.Record)» , «see M:WixToolset.Dtf.WindowsInstaller.View.ValidateNew(WixToolset.Dtf.WindowsInstaller.Record)» , or «see M:WixToolset.Dtf.WindowsInstaller.View.ValidateFields(WixToolset.Dtf.WindowsInstaller.Record)» methods of the «see T:WixToolset.Dtf.WindowsInstaller.View» class.

Interfaces

InterfaceDescription
IEmbeddedUI[MSI 4.5] Interface for an embedded external user interface for an installation.

Enumerations

EnumerationDescription
ActionResultSpecifies a return status value for custom actions.
ComponentAttributesAvailable values for the Attributes column of the Component table.
ControlAttributesDefines flags for the Attributes column of the Control table.
CustomActionTypesDefines flags for the Type column of the CustomAction table.
DatabaseOpenModeSpecifies the open mode for a «see T:WixToolset.Dtf.WindowsInstaller.Database» .
DialogAttributesDefines flags for the Attributes column of the Dialog table.
FeatureAttributesAvailable values for the Attributes column of the Feature table.
FileAttributesAvailable values for the Attributes column of the File table.
IniFileActionDefines values for the Action column of the IniFile and RemoveIniFile tables.
InstallLogModesLog modes available for «see M:WixToolset.Dtf.WindowsInstaller.Installer.EnableLog(WixToolset.Dtf.WindowsInstaller.InstallLogModes,System.String)» and «see M:WixToolset.Dtf.WindowsInstaller.Installer.SetExternalUI(WixToolset.Dtf.WindowsInstaller.ExternalUIHandler,WixToolset.Dtf.WindowsInstaller.InstallLogModes)» .
InstallMessageType of message to be processed by «see M:WixToolset.Dtf.WindowsInstaller.Session.Message(WixToolset.Dtf.WindowsInstaller.InstallMessage,WixToolset.Dtf.WindowsInstaller.Record)» , «see T:WixToolset.Dtf.WindowsInstaller.ExternalUIHandler» , or «see T:WixToolset.Dtf.WindowsInstaller.ExternalUIRecordHandler» .
InstallModeSpecifies the install mode for «see M:WixToolset.Dtf.WindowsInstaller.Installer.ProvideComponent(System.String,System.String,System.String,WixToolset.Dtf.WindowsInstaller.InstallMode)» or «see M:WixToolset.Dtf.WindowsInstaller.Installer.ProvideQualifiedComponent(System.String,System.String,WixToolset.Dtf.WindowsInstaller.InstallMode,System.String)» .
InstallRunModeSpecifies the run mode for «see M:WixToolset.Dtf.WindowsInstaller.Session.GetMode(WixToolset.Dtf.WindowsInstaller.InstallRunMode)» .
InstallStateInstalled state of a Component or Feature.
InstallTypeSpecifies the type of installation for «see M:WixToolset.Dtf.WindowsInstaller.Installer.ApplyPatch(System.String,System.String,WixToolset.Dtf.WindowsInstaller.InstallType,System.String)» .
InstallUIOptionsLevel of the installation user interface, specified with «see M:WixToolset.Dtf.WindowsInstaller.Installer.SetInternalUI(WixToolset.Dtf.WindowsInstaller.InstallUIOptions)» .
LocatorTypesDefines values for the Type column of the CompLocator, IniLocator, and RegLocator tables.
MessageBoxStyles
MessageButtonsSpecifies constants defining which buttons to display for a message. This can be cast to the MessageBoxButtons enum in System.Windows.Forms and System.Windows.
MessageDefaultButtonSpecifies constants defining the default button on a message. This can be cast to the MessageBoxDefaultButton enum in System.Windows.Forms and System.Windows.
MessageIconSpecifies constants defining which information to display. This can be cast to the MessageBoxIcon enum in System.Windows.Forms and System.Windows.
MessageResultSpecifies a return status value for message handlers. These values are returned by «see M:WixToolset.Dtf.WindowsInstaller.Session.Message(WixToolset.Dtf.WindowsInstaller.InstallMessage,WixToolset.Dtf.WindowsInstaller.Record)» , «see T:WixToolset.Dtf.WindowsInstaller.ExternalUIHandler» , and «see M:WixToolset.Dtf.WindowsInstaller.IEmbeddedUI.ProcessMessage(WixToolset.Dtf.WindowsInstaller.InstallMessage,WixToolset.Dtf.WindowsInstaller.Record,WixToolset.Dtf.WindowsInstaller.MessageButtons,WixToolset.Dtf.WindowsInstaller.MessageIcon,WixToolset.Dtf.WindowsInstaller.MessageDefaultButton)» .
PatchStatesSpecifies the different patch states for «see M:WixToolset.Dtf.WindowsInstaller.PatchInstallation.GetPatches(System.String,System.String,System.String,WixToolset.Dtf.WindowsInstaller.UserContexts,WixToolset.Dtf.WindowsInstaller.PatchStates)» .
RegistryRootDefines values for the Root column of the Registry, RemoveRegistry, and RegLocator tables.
ReinstallModesSpecifies the reinstall mode for «see M:WixToolset.Dtf.WindowsInstaller.Installer.ReinstallFeature(System.String,System.String,WixToolset.Dtf.WindowsInstaller.ReinstallModes)» or «see M:WixToolset.Dtf.WindowsInstaller.Installer.ReinstallProduct(System.String,WixToolset.Dtf.WindowsInstaller.ReinstallModes)» .
RemoveFileModesDefines values for the InstallMode column of the RemoveFile table.
ServiceAttributesDefines values for the ServiceType, StartType, and ErrorControl columns of the ServiceInstall table.
ServiceControlEventsDefines values for the Event column of the ServiceControl table.
TextStylesDefines values for the StyleBits column of the TextStyle table.
TransactionAttributesAttributes for «see T:WixToolset.Dtf.WindowsInstaller.Transaction» methods.
TransformErrorsTransform error conditions available for «see M:WixToolset.Dtf.WindowsInstaller.Database.CreateTransformSummaryInfo(WixToolset.Dtf.WindowsInstaller.Database,System.String,WixToolset.Dtf.WindowsInstaller.TransformErrors,WixToolset.Dtf.WindowsInstaller.TransformValidations)» or «see M:WixToolset.Dtf.WindowsInstaller.Database.ApplyTransform(System.String,WixToolset.Dtf.WindowsInstaller.TransformErrors)» .
TransformValidationsTransform validation flags available for «see M:WixToolset.Dtf.WindowsInstaller.Database.CreateTransformSummaryInfo(WixToolset.Dtf.WindowsInstaller.Database,System.String,WixToolset.Dtf.WindowsInstaller.TransformErrors,WixToolset.Dtf.WindowsInstaller.TransformValidations)» .
UpgradeAttributesDefines values for the Attributes column of the Upgrade table.
UserContextsSpecifies the installation context for «see T:WixToolset.Dtf.WindowsInstaller.ProductInstallation» s, «see T:WixToolset.Dtf.WindowsInstaller.PatchInstallation» es, and «see M:WixToolset.Dtf.WindowsInstaller.Installer.DetermineApplicablePatches(System.String,System.String[],WixToolset.Dtf.WindowsInstaller.InapplicablePatchHandler,System.String,WixToolset.Dtf.WindowsInstaller.UserContexts)»
ValidationErrorDefines the type of error encountered by the «see M:WixToolset.Dtf.WindowsInstaller.View.Validate(WixToolset.Dtf.WindowsInstaller.Record)» , «see M:WixToolset.Dtf.WindowsInstaller.View.ValidateNew(WixToolset.Dtf.WindowsInstaller.Record)» , or «see M:WixToolset.Dtf.WindowsInstaller.View.ValidateFields(WixToolset.Dtf.WindowsInstaller.Record)» methods of the «see T:WixToolset.Dtf.WindowsInstaller.View» class.
ViewModifyModeSpecifies the modify mode for «see M:WixToolset.Dtf.WindowsInstaller.View.Modify(WixToolset.Dtf.WindowsInstaller.ViewModifyMode,WixToolset.Dtf.WindowsInstaller.Record)» .

Delegates

DelegateDescription
ExternalUIHandlerDefines a callback function that the installer calls for progress notification and error messages.
ExternalUIRecordHandler[MSI 3.1] Defines a callback function that the installer calls for record-based progress notification and error messages.
InapplicablePatchHandlerReceives an exception from «see M:WixToolset.Dtf.WindowsInstaller.Installer.DetermineApplicablePatches(System.String,System.String[],WixToolset.Dtf.WindowsInstaller.InapplicablePatchHandler,System.String,WixToolset.Dtf.WindowsInstaller.UserContexts)» indicating the reason a particular patch is not applicable to a product.