UsageWriterWritePositionalArgumentName Method

Writes the name of a positional argument.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
protected virtual void WritePositionalArgumentName(
	string argumentName,
	string prefix,
	char? separator
)

Parameters

argumentName  String
The name of the argument.
prefix  String
The argument name prefix; if using ParsingModeLongShort, this may vary depending on whether the name is a short or long name.
separator  NullableChar
The argument name/value separator, or if the UseWhiteSpaceValueSeparator property and the CommandLineParserAllowWhiteSpaceValueSeparator property are both .

Remarks

The default implementation surrounds the value written by the WriteArgumentName(String, String) method, as well as the separator if not , with square brackets. For example, "[-Name]" or "[-Name:]", to indicate the name itself is optional.

This method is called by the base implementation of the WriteArgumentSyntax(CommandLineArgument) method.

See Also