Skip to main content

IBootstrapperCommand Interface

Command information passed from the engine for the BA to perform.

Methods​

MethodDescription
ParseCommandLine()Parses the command line arguments into an «see T:WixToolset.Mba.Core.IMbaCommand» .

Properties​

PropertyDescription
ActionGets the action for the BA to perform.
BootstrapperApplicationDataPathGets path to BootstrapperApplicationData.xml.
BootstrapperWorkingFolderGets bootstrapper working folder.
CmdShowHint for the initial visibility of the window.
CommandLineGets the command line arguments.
DisplayGets the display level for the BA.
LayoutDirectoryGets layout directory.
PassthroughIf this was run from a backward compatible bundle.
RelationIf this was run from a related bundle, specifies the relation type.
ResumeGets the method of how the engine was resumed from a previous installation step.
SplashScreenGets the handle to the splash screen window. If no splash screen was displayed this value will be IntPtr.Zero.

WixToolset.Mba.Core.dll version 4.0.6+73c897383236ddbbbc6ba257634013c1269ceec2

ParseCommandLine() Method​

Parses the command line arguments into an «see T:WixToolset.Mba.Core.IMbaCommand» .

Declaration​

public IMbaCommand ParseCommandLine()

Return value​

IMbaCommand The parsed information.

Exceptions​

ExceptionDescription
The command line could not be parsed.

Action Property​

Gets the action for the BA to perform.

Declaration​

public LaunchAction Action { get; set; } 

BootstrapperApplicationDataPath Property​

Gets path to BootstrapperApplicationData.xml.

Declaration​

public string BootstrapperApplicationDataPath { get; set; } 

BootstrapperWorkingFolder Property​

Gets bootstrapper working folder.

Declaration​

public string BootstrapperWorkingFolder { get; set; } 

CmdShow Property​

Hint for the initial visibility of the window.

Declaration​

public int CmdShow { get; set; } 

CommandLine Property​

Gets the command line arguments.

Declaration​

public string CommandLine { get; set; } 

Display Property​

Gets the display level for the BA.

Declaration​

public Display Display { get; set; } 

LayoutDirectory Property​

Gets layout directory.

Declaration​

public string LayoutDirectory { get; set; } 

Passthrough Property​

If this was run from a backward compatible bundle.

Declaration​

public bool Passthrough { get; set; } 

Relation Property​

If this was run from a related bundle, specifies the relation type.

Declaration​

public RelationType Relation { get; set; } 

Resume Property​

Gets the method of how the engine was resumed from a previous installation step.

Declaration​

public ResumeType Resume { get; set; } 

SplashScreen Property​

Gets the handle to the splash screen window. If no splash screen was displayed this value will be IntPtr.Zero.

Declaration​

public IntPtr SplashScreen { get; set; }