CommandManager.RunCommandAsync(String, ReadOnlyMemory<String>) 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: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public Task<int?> RunCommandAsync(
	string? commandName,
	ReadOnlyMemory<string> args
)

Parameters

commandName  String
The name of the command.
args  ReadOnlyMemory<String>
The arguments to the command.

Return Value

Task<Nullable<Int32>>
A task representing the asynchronous run operation. The result is the value returned by IAsyncCommand.RunAsync() or ICommand.Run(), or null if the command could not be created.

Remarks

This function creates the command by invoking the CreateCommand(String, ReadOnlyMemory<String>) method. If the command implements the IAsyncCancelableCommand interface, it sets the IAsyncCancelableCommand.CancellationToken property. If the command implements the IAsyncCommand interface, it invokes the IAsyncCommand.RunAsync() method; otherwise, it invokes the ICommand.Run() method on the command.

Commands that don't meet the criteria of the CommandOptions.CommandFilter predicate are not included.

If the CommandOptions.ParentCommand property is null, only commands without a ParentCommandAttribute attribute are included. If it is not null, only commands where the type specified using the ParentCommandAttribute attribute matches the value of the property are included.

The automatic version command is included if the CommandOptions.AutoVersionCommand property is true and the command name matches the name of the automatic version command, and not any other command name. The CommandOptions.CommandFilter and CommandOptions.ParentCommand property also affect whether the version command is included.

See Also