ClassValidationAttribute.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(
	CommandLineParser parser
)

VB
Public Overridable Function GetUsageHelp ( 
	parser As CommandLineParser
) As String

Dim instance As ClassValidationAttribute
Dim parser As CommandLineParser

Dim returnValue As String

returnValue = instance.GetUsageHelp(parser)

C++
public:
virtual String^ GetUsageHelp(
	CommandLineParser^ parser
)

Parameters

parser CommandLineParser: The parser 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

ClassValidationAttribute Class

Ookii.CommandLine.Validation Namespace