CommandExtensions.Parse Method

Definition

Namespace:

System.CommandLine

Assembly:

System.CommandLine.dll

Overloads

Parse(Command, String)	Parses a command line string value using the specified command.
Parse(Command, String[])	Parses an array strings using the specified command.

Parse(Command, String)

Parses a command line string value using the specified command.

public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Parsing::ParseResult ^ Parse(System::CommandLine::Command ^ command, System::String ^ commandLine);

public static System.CommandLine.Parsing.ParseResult Parse (this System.CommandLine.Command command, string commandLine);

static member Parse : System.CommandLine.Command * string -> System.CommandLine.Parsing.ParseResult

<Extension()>
Public Function Parse (command As Command, commandLine As String) As ParseResult

Parameters

command

Command

The command to use to parse the command line input.

commandLine

String

A command line string to parse, which can include spaces and quotes equivalent to what can be entered into a terminal.

Returns

ParseResult

A parse result describing the outcome of the parse operation.

Remarks

The command line string input will be split into tokens as if it had been passed on the command line.

Parse(Command, String[])

Parses an array strings using the specified command.

public:
[System::Runtime::CompilerServices::Extension]
 static System::CommandLine::Parsing::ParseResult ^ Parse(System::CommandLine::Command ^ command, ... cli::array <System::String ^> ^ args);

public static System.CommandLine.Parsing.ParseResult Parse (this System.CommandLine.Command command, params string[] args);

static member Parse : System.CommandLine.Command * string[] -> System.CommandLine.Parsing.ParseResult

<Extension()>
Public Function Parse (command As Command, ParamArray args As String()) As ParseResult

Parameters

command

Command

The command to use to parse the command line input.

args

String[]

The string arguments to parse.

Returns

ParseResult

A parse result describing the outcome of the parse operation.