Skip to main content

ICommandLineCommand Interface

Custom command.

Methods​

MethodDescription
ExecuteAsync(cancellationToken)Executes the command.
GetCommandLineHelp()Gets the help for this command.
TryParseArgument(parser, argument)Allows the command to parse command-line arguments.

Properties​

PropertyDescription
ShowLogoIndicates the command-line should show the logo.
StopParsingIndicates the command-line parsing can stop.

WixToolset.Extensibility.dll version 6.0.0+8c7432e50072e009353ea5f2c956ccf453476f71

ExecuteAsync(cancellationToken) Method​

Executes the command.

Declaration​

public System.Threading.Tasks.Task<System.Int32> ExecuteAsync(
System.Threading.CancellationToken cancellationToken
)

Parameters​

ParameterTypeDescription
cancellationTokenSystem.Threading.CancellationTokenCancellation token.

Return value​

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

GetCommandLineHelp() Method​

Gets the help for this command.

Declaration​

public CommandLineHelp GetCommandLineHelp()

TryParseArgument(parser, argument) Method​

Allows the command to parse command-line arguments.

Declaration​

public bool TryParseArgument(
WixToolset.Extensibility.Services.ICommandLineParser parser,
string argument
)

Parameters​

ParameterTypeDescription
parserWixToolset.Extensibility.Services.ICommandLineParserParser to help parse the argument and additional arguments.
argumentstringArgument to parse.

Return value​

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

Indicates the command-line should show the logo.

Declaration​

public bool ShowLogo { get; set; } 

StopParsing Property​

Indicates the command-line parsing can stop.

Declaration​

public bool StopParsing { get; set; }