ICommandLineCommand Interface
Custom command.
Methods
Section titled “Methods”| Method | Description |
|---|---|
| ExecuteAsync(cancellationToken) | Executes the command. |
| GetCommandLineHelp() | Gets the help for this command. |
| TryParseArgument(parser, argument) | Allows the command to parse command-line arguments. |
Properties
Section titled “Properties”| Property | Description |
|---|---|
| ShowLogo | Indicates the command-line should show the logo. |
| StopParsing | Indicates the command-line parsing can stop. |
WixToolset.Extensibility.dll version 5.0.0+41e11442b2ca93e444b60213b5ae99dcbab787d8 |
ExecuteAsync(cancellationToken) Method
Section titled “ExecuteAsync(cancellationToken) Method”Executes the command.
Declaration
Section titled “Declaration”public System.Threading.Tasks.Task<System.Int32> ExecuteAsync( System.Threading.CancellationToken cancellationToken)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| cancellationToken | System.Threading.CancellationToken | Cancellation token. |
Return value
Section titled “Return value”System.Threading.Tasks.Task<System.Int32> Exit code for the command.
GetCommandLineHelp() Method
Section titled “GetCommandLineHelp() Method”Gets the help for this command.
Declaration
Section titled “Declaration”public CommandLineHelp GetCommandLineHelp()TryParseArgument(parser, argument) Method
Section titled “TryParseArgument(parser, argument) Method”Allows the command to parse command-line arguments.
Declaration
Section titled “Declaration”public bool TryParseArgument( WixToolset.Extensibility.Services.ICommandLineParser parser, string argument)Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
| parser | WixToolset.Extensibility.Services.ICommandLineParser | Parser to help parse the argument and additional arguments. |
| argument | string | Argument to parse. |
Return value
Section titled “Return value”bool True if the argument is recognized; otherwise false to allow another extension to process it.
ShowLogo Property
Section titled “ShowLogo Property”Indicates the command-line should show the logo.
Declaration
Section titled “Declaration”public bool ShowLogo { get; set; }StopParsing Property
Section titled “StopParsing Property”Indicates the command-line parsing can stop.
Declaration
Section titled “Declaration”public bool StopParsing { get; set; }