UsageWriterGetUsage Method

public string GetUsage(
	CommandLineParser parser,
	UsageHelpRequest request = UsageHelpRequest.Full,
	int maximumLineLength = 0
)

Public Function GetUsage ( 
	parser As CommandLineParser,
	Optional request As UsageHelpRequest = UsageHelpRequest.Full,
	Optional maximumLineLength As Integer = 0
) As String

Dim instance As UsageWriter
Dim parser As CommandLineParser
Dim request As UsageHelpRequest
Dim maximumLineLength As Integer

Dim returnValue As String

returnValue = instance.GetUsage(parser, 
	request, maximumLineLength)

public:
String^ GetUsage(
	CommandLineParser^ parser, 
	UsageHelpRequest request = UsageHelpRequest::Full, 
	int maximumLineLength = 0
)

Parameters

parser  CommandLineParser

The CommandLineParser.

request  UsageHelpRequest  (Optional)

The parts of usage to write.

maximumLineLength  Int32  (Optional)

The length at which to white-space wrap lines in the output, or 0 to disable wrapping.

Return Value

This method ignores the writer passed to the UsageWriter(LineWrappingTextWriter, NullableBoolean) constructor, and will use the LineWrappingTextWriterForStringWriter(Int32, IFormatProvider, Boolean) method instead, and returns the resulting string. If color support was not explicitly enabled, it will be disabled.

This method calls the WriteParserUsageCore(UsageHelpRequest) method to create the usage help text.

Reference