CommandLineParserTParse(ReadOnlyMemoryString) Method

Parses the specified command line arguments.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086

C#

public T Parse(
	ReadOnlyMemory<string> args
)

VB

Public Function Parse ( 
	args As ReadOnlyMemory(Of String)
) As T

Dim instance As CommandLineParser
Dim args As ReadOnlyMemory(Of String)

Dim returnValue As T

returnValue = instance.Parse(args)

C++

public:
T Parse(
	ReadOnlyMemory<String^> args
)

Parameters

args ReadOnlyMemoryString: The command line arguments.

Return Value

T
An instance of the type specified by the ArgumentsType property, or if argument parsing was canceled by the ArgumentParsed event handler, the CommandLineArgumentAttributeCancelParsing property, or a method argument that returned CancelModeAbort or .

Remarks

If the return value is , check the HelpRequested property to see if usage help should be displayed.

Exceptions

CommandLineArgumentException

An error occurred parsing the command line. Check the CommandLineArgumentExceptionCategory property for the exact reason for the error.