UsageWriter.WritePositionalArgumentName Method

Writes the name of a positional argument.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1
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 LongShort, this may vary depending on whether the name is a short or long name.
separator  Nullable<Char>
The argument name/value separator, or null if the UseWhiteSpaceValueSeparator property and the AllowWhiteSpaceValueSeparator property are both true.

Remarks

The default implementation surrounds the value written by the WriteArgumentName(String, String) method, as well as the separator if not null, 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