CommandLineParserGetUsage Method

Gets command line usage help using the default options and no line wrapping.

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 2.4.0

Syntax

public string GetUsage()

Public Function GetUsage As String

Dim instance As CommandLineParser
Dim returnValue As String

returnValue = instance.GetUsage()

public:
String^ GetUsage()

Return Value

Type: String
A string containing usage help for the command line options defined by the type specified by ArgumentsType.

Remarks

The usage help consists of first the Description, followed by the usage syntax, followed by a description of all the arguments.

You can add descriptions to the usage text by applying the DescriptionAttribute attribute to your command line arguments type, and the constructor parameters and properties defining command line arguments.

This method indents additional lines for the usage syntax and argument descriptions.

Reference

CommandLineParser Class

GetUsage Overload

Ookii.CommandLine Namespace

CommandLineParserAddLanguageSpecificTextSet("LST8641488D_0?cpp=::|nu=.");GetUsage Method

Return Value

Reference

CommandLineParserGetUsage Method