CommandManagerRunCommand(String, Int32) Method

Finds and instantiates the subcommand with the name from the first argument, and if it succeeds, runs it. 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 int? RunCommand(
	string[] args,
	int index = 0
)

VB

Public Function RunCommand ( 
	args As String(),
	Optional index As Integer = 0
) As Integer?

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

Dim returnValue As Integer?

returnValue = instance.RunCommand(args, 
	index)

C++

public:
Nullable<int> RunCommand(
	array<String^>^ args, 
	int index = 0
)

Parameters

args String: The arguments to the command.
index Int32 (Optional): The index in args at which to start parsing the arguments.

Return Value

NullableInt32
The value returned by Run, or if the command could not be created.

Remarks

This function creates the command by invoking the CreateCommand(String, Int32), method and then invokes the Run method on the command.

Exceptions

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