CommandLineParserTParse(String) Method

Parses the specified command line arguments.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83

C#

public T Parse(
	string[] args
)

VB

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

Dim instance As CommandLineParser
Dim args As String()

Dim returnValue As T

returnValue = instance.Parse(args)

C++

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

Parameters

args String: 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

ArgumentNullException	args is .
CommandLineArgumentException	An error occurred parsing the command line. Check the CommandLineArgumentExceptionCategory property for the exact reason for the error.