ParseResultExtensions.InvokeAsync(ParseResult, IConsole) Method

Definition

Namespace:

System.CommandLine.Parsing

Assembly:

System.CommandLine.dll

Invokes the appropriate command handler for a parsed command line input.

public static System.Threading.Tasks.Task<int> InvokeAsync (this System.CommandLine.Parsing.ParseResult parseResult, System.CommandLine.IConsole? console = default);

static member InvokeAsync : System.CommandLine.Parsing.ParseResult * System.CommandLine.IConsole -> System.Threading.Tasks.Task<int>

<Extension()>
Public Function InvokeAsync (parseResult As ParseResult, Optional console As IConsole = Nothing) As Task(Of Integer)

Parameters

parseResult

ParseResult

A parse result on which the invocation is based.

console

IConsole

A console to which output can be written. By default, Console is used.

Returns

Task<Int32>

A task whose result can be used as a process exit code.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Invoke(ParseResult, IConsole).