CommandLineParserParseT(String, Int32, ParseOptions) Method

public static T Parse<T>(
	string[] args,
	int index,
	ParseOptions? options = null
)
where T : class

Public Shared Function Parse(Of T As Class) ( 
	args As String(),
	index As Integer,
	Optional options As ParseOptions = Nothing
) As T

Dim args As String()
Dim index As Integer
Dim options As ParseOptions

Dim returnValue As T

returnValue = CommandLineParser.Parse(args, index, 
	options)

public:
generic<typename T>
where T : ref class
static T Parse(
	array<String^>^ args, 
	int index, 
	ParseOptions^ options = nullptr
)

Parameters

args  String

The command line arguments.

index  Int32

The index of the first argument to parse.

options  ParseOptions  (Optional)

The options that control parsing behavior and usage help formatting. If , the default options are used.

Type Parameters

T

The type defining the command line arguments.

Return Value

This is a convenience function that instantiates a CommandLineParser, calls the Parse method, and returns the result. If an error occurs or parsing is canceled, it prints errors to the Error stream, and usage help to the UsageWriter if the HelpRequested property is . It then returns .

If the Error parameter is , output is written to a LineWrappingTextWriter for the standard error stream, wrapping at the console's window width. If the stream is redirected, output may still be wrapped, depending on the value returned by WindowWidth.

Color is applied to the output depending on the value of the UseColor property, the UseErrorColor property, and the capabilities of the console.

If you want more control over the parsing process, including custom error/usage output or handling the ArgumentParsed event, you should manually create an instance of the CommandLineParserT class and call its Parse method.

Reference