CommandLineParserGetUsage Method (Int32, WriteUsageOptions)

public string GetUsage(
	int maximumLineLength,
	WriteUsageOptions options
)

Public Function GetUsage ( 
	maximumLineLength As Integer,
	options As WriteUsageOptions
) As String

Dim instance As CommandLineParser
Dim maximumLineLength As Integer
Dim options As WriteUsageOptions
Dim returnValue As String

returnValue = instance.GetUsage(maximumLineLength, 
	options)

public:
String^ GetUsage(
	int maximumLineLength, 
	WriteUsageOptions^ options
)

Parameters

maximumLineLength

Type: SystemInt32
The maximum line length of lines in the usage text; . A value less than 1 or larger than 65536 is interpreted as infinite line length.

options

Type: Ookii.CommandLineWriteUsageOptions
The options to use for formatting the usage.

Return Value

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.

Line wrapping at word boundaries is applied to the output, wrapping at the specified line length.

This method indents additional lines for the usage syntax and argument descriptions, unless the maximum line length is less than 30.

Reference