CommandManagerRunCommandAsync(String, String, Int32) Method

Finds and instantiates the subcommand with the specified name, and if it succeeds, runs it asynchronously. If it fails, writes error and usage information.

Definition

Namespace: Ookii.CommandLine.Commands
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1

C#

public Task<int?> RunCommandAsync(
	string? commandName,
	string[] args,
	int index
)

VB

Public Function RunCommandAsync ( 
	commandName As String,
	args As String(),
	index As Integer
) As Task(Of Integer?)

Dim instance As CommandManager
Dim commandName As String
Dim args As String()
Dim index As Integer

Dim returnValue As Task(Of Integer?)

returnValue = instance.RunCommandAsync(commandName, 
	args, index)

C++

public:
Task<Nullable<int>>^ RunCommandAsync(
	String^ commandName, 
	array<String^>^ args, 
	int index
)

Parameters

commandName String: The name of the command.
args String: The arguments to the command.
index Int32: The index in args at which to start parsing the arguments.

Return Value

TaskNullableInt32
A task representing the asynchronous run operation. The result is the value returned by RunAsync, or if the command could not be created.

Remarks

This function creates the command by invoking the CreateCommand(String, String, Int32), method. If the command implements the IAsyncCommand interface, it invokes the RunAsync method; otherwise, it invokes the Run method on the command.

Exceptions

ArgumentNullException	args is
ArgumentOutOfRangeException	index does not fall inside the bounds of args.