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