Skip to content

ICommandLineCommand Interface

Custom command.

MethodDescription
ExecuteAsync(cancellationToken)Executes the command.
GetCommandLineHelp()Gets the help for this command.
TryParseArgument(parser, argument)Allows the command to parse command-line arguments.
PropertyDescription
ShowLogoIndicates the command-line should show the logo.
StopParsingIndicates the command-line parsing can stop.
WixToolset.Extensibility.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8

Executes the command.

public System.Threading.Tasks.Task<System.Int32> ExecuteAsync(
System.Threading.CancellationToken cancellationToken
)
ParameterTypeDescription
cancellationTokenSystem.Threading.CancellationTokenCancellation token.

System.Threading.Tasks.Task<System.Int32> Exit code for the command.

Gets the help for this command.

public CommandLineHelp GetCommandLineHelp()

Allows the command to parse command-line arguments.

public bool TryParseArgument(
WixToolset.Extensibility.Services.ICommandLineParser parser,
string argument
)
ParameterTypeDescription
parserWixToolset.Extensibility.Services.ICommandLineParserParser to help parse the argument and additional arguments.
argumentstringArgument to parse.

bool True if the argument is recognized; otherwise false to allow another extension to process it.

Indicates the command-line should show the logo.

public bool ShowLogo { get; set; }

Indicates the command-line parsing can stop.

public bool StopParsing { get; set; }