CommandLineParserGetUsage Method

public string GetUsage(
	UsageWriter? usageWriter = null,
	int maximumLineLength = 0
)

Public Function GetUsage ( 
	Optional usageWriter As UsageWriter = Nothing,
	Optional maximumLineLength As Integer = 0
) As String

Dim instance As CommandLineParser
Dim usageWriter As UsageWriter
Dim maximumLineLength As Integer

Dim returnValue As String

returnValue = instance.GetUsage(usageWriter, 
	maximumLineLength)

public:
String^ GetUsage(
	UsageWriter^ usageWriter = nullptr, 
	int maximumLineLength = 0
)

Parameters

usageWriter  UsageWriter  (Optional)

The UsageWriter to use to create the usage. If , the value from the ParseOptionsUsageWriter property in the Options property is used.

maximumLineLength  Int32  (Optional)

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.

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 properties and methods defining command line arguments.

Color is applied to the output only if the UsageWriter instance has enabled it.

Reference