Static method: TArgs ParseOrWriteUsageToConsole<TArgs>(string[], Func<ConsoleColoredString, ConsoleColoredString>)

• Declared in: RT.CommandLine.CommandLineParser

Declaration

public static TArgs ParseOrWriteUsageToConsole<TArgs>(
    string[] args,
    Func<ConsoleColoredString, ConsoleColoredString> helpProcessor = null
)

Summary

Parses the specified command-line arguments into an instance of the specified type. In case of failure, prints usage information to the console and returns default(TArgs). See the remarks section of the documentation for CommandLineParser for features and limitations.

Generic type parameters

TArgs

The class containing the fields and attributes which define the command-line syntax.

Parameters

string[]	args	The command-line arguments to be parsed.
Func<ConsoleColoredString, ConsoleColoredString>	helpProcessor	Specifies a callback which is invoked on every documentation string retrieved from the DocumentationAttributes to generate the help text. This callback can modify the text arbitrarily.

Returns

An instance of the class TArgs containing the options and parameters specified by the user on the command line.