ArgumentValidationAttributeValidateSpan Method

Validates the argument value, and throws an exception if validation failed.

Definition

Namespace: Ookii.CommandLine.Validation
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086

C#

public bool ValidateSpan(
	CommandLineArgument argument,
	ReadOnlySpan<char> value
)

VB

Public Function ValidateSpan ( 
	argument As CommandLineArgument,
	value As ReadOnlySpan(Of Char)
) As Boolean

Dim instance As ArgumentValidationAttribute
Dim argument As CommandLineArgument
Dim value As ReadOnlySpan(Of Char)

Dim returnValue As Boolean

returnValue = instance.ValidateSpan(argument, 
	value)

C++

public:
bool ValidateSpan(
	CommandLineArgument^ argument, 
	ReadOnlySpan<wchar_t> value
)

Parameters

argument CommandLineArgument: The argument being validated.
value ReadOnlySpanChar: The argument value. If not , this must be an instance of CommandLineArgumentArgumentType.

Return Value

Boolean
if validation was performed and successful; if this validator doesn't support validating spans and the Validate(CommandLineArgument, Object) method should be used instead.

Remarks

The CommandLineParser class will only call this method if the Mode property is ValidationModeBeforeConversion.

Exceptions

CommandLineArgumentException

The value parameter is not a valid value. The CommandLineArgumentExceptionCategory property will be the value of the ErrorCategory property.