ComponentInfo Class
Provides access to information about a component within the context of an installation session.
Methods
| Method | Description |
|---|---|
| GetCost(installState) | Gets disk space per drive required to install a component. |
Properties
| Property | Description |
|---|---|
| CurrentState | Gets the current install state of the designated Component. |
| Name | Gets the name of the component (primary key in the Component table). |
| RequestState | Gets or sets the action state of the designated Component. |
WixToolset.Dtf.WindowsInstaller.dll version 5.0.2+aa65968c419420d32e3e1b647aea0082f5ca5b78
GetCost(installState) Method
Gets disk space per drive required to install a component.
Declaration
public IList<WixToolset.Dtf.WindowsInstaller.InstallCost> GetCost(
InstallState installState
)
Parameters
| Parameter | Type | Description |
|---|---|---|
| installState | InstallState | Requested component state |
Return value
IList<WixToolset.Dtf.WindowsInstaller.InstallCost> A list of InstallCost structures, specifying the cost for each drive for the component
Remarks
Win32 MSI API: MsiEnumComponentCosts
CurrentState Property
Gets the current install state of the designated Component.
Declaration
public InstallState CurrentState { get; set; }
Remarks
Win32 MSI API: MsiGetComponentState
Exceptions
| Exception | Description |
|---|---|
| T:WixToolset.Dtf.WindowsInstaller.InvalidHandleException | the Session handle is invalid |
| T:System.ArgumentException | an unknown Component was requested |
Name Property
Gets the name of the component (primary key in the Component table).
Declaration
public string Name { get; set; }
RequestState Property
Gets or sets the action state of the designated Component.
Declaration
public InstallState RequestState { get; set; }
Remarks
Win32 MSI APIs: MsiGetComponentState , MsiSetComponentState
Exceptions
| Exception | Description |
|---|---|
| T:WixToolset.Dtf.WindowsInstaller.InvalidHandleException | the Session handle is invalid |
| T:System.ArgumentException | an unknown Component was requested |
| T:WixToolset.Dtf.WindowsInstaller.InstallCanceledException | the user exited the installation |