Option.HelpName Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the placeholder name shown in usage help for the option's value.
The value will be wrapped in angle brackets (< and >).
public:
property System::String ^ HelpName { System::String ^ get(); void set(System::String ^ value); };public string? HelpName { get; set; }member this.HelpName : string with get, setPublic Property HelpName As StringProperty Value
The name to show as the placeholder for the option's value.
Examples
An option with Name of --option and a
HelpName of Value will be shown in usage help as:
--option <Value>. If HelpName is not set,
help output will show: --option <option>.
Remarks
If null, the Name of the option will be used, with leading dashes and slashes removed.
