UsageWriterWriteCommandHelpInstruction Method

Writes an instruction on how to get help on a command.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
protected virtual void WriteCommandHelpInstruction(
	string name,
	string argumentNamePrefix,
	string argumentName
)

Parameters

name  String
The application and command name.
argumentNamePrefix  String
The argument name prefix for a help argument.
argumentName  String
The automatic help argument name.

Remarks

The base implementation writes a string like "Run 'executable command -Help' for more information on a command."

This method is called by the base implementation of the WriteCommandListUsageCore method if the IncludeCommandHelpInstruction property is , or if it is and all commands meet the requirements.

See Also