ArgumentValidationAttribute.GetUsageHelp Method

Gets the usage help message for this validator.

Definition

Namespace: Ookii.CommandLine.Validation
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 3.1.1

C#
public virtual string? GetUsageHelp(
	CommandLineArgument argument
)

VB
Public Overridable Function GetUsageHelp ( 
	argument As CommandLineArgument
) As String

Dim instance As ArgumentValidationAttribute
Dim argument As CommandLineArgument

Dim returnValue As String

returnValue = instance.GetUsageHelp(argument)

C++
public:
virtual String^ GetUsageHelp(
	CommandLineArgument^ argument
)

Parameters

argument CommandLineArgument: The argument is the validator is for.

Return Value

String
The usage help message, or null if there is none. The base implementation always returns null.

Remarks

This function is only called if the IncludeValidatorsInDescription property is true.

See Also

Reference

ArgumentValidationAttribute Class

Ookii.CommandLine.Validation Namespace