UsageWriterGetCommandListUsage Method

public string GetCommandListUsage(
	CommandManager manager,
	int maximumLineLength = 0
)

Public Function GetCommandListUsage ( 
	manager As CommandManager,
	Optional maximumLineLength As Integer = 0
) As String

Dim instance As UsageWriter
Dim manager As CommandManager
Dim maximumLineLength As Integer

Dim returnValue As String

returnValue = instance.GetCommandListUsage(manager, 
	maximumLineLength)

public:
String^ GetCommandListUsage(
	CommandManager^ manager, 
	int maximumLineLength = 0
)

Parameters

manager  CommandManager

The CommandManager.

maximumLineLength  Int32  (Optional)

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

Return Value

The usage help will contain a list of all available commands.

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 WriteCommandListUsageCore method to create the usage help text.

Reference