ICommandLineCommand Interface
Custom command.
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
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.2+aa65968c419420d32e3e1b647aea0082f5ca5b78
ExecuteAsync(cancellationToken) Method
Executes the command.
Declaration
public System.Threading.Tasks.Task<System.Int32> ExecuteAsync(
System.Threading.CancellationToken cancellationToken
)
Parameters
Parameter | Type | Description |
---|---|---|
cancellationToken | System.Threading.CancellationToken | Cancellation 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
Parameter | Type | Description |
---|---|---|
parser | WixToolset.Extensibility.Services.ICommandLineParser | Parser to help parse the argument and additional arguments. |
argument | string | Argument to parse. |
Return value
bool
True if the argument is recognized; otherwise false to allow another extension to process it.
ShowLogo Property
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; }