OptionsBuilder.Validate Method

Definition

Namespace:: Microsoft.Extensions.Options

Assembly:: Microsoft.Extensions.Options.dll

Package:: Microsoft.Extensions.Options v11.0.0-rc.1.26425.128

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.

Overloads

Name	Description
Validate(Func)	Registers a validation action for an options type using a default failure message.
Validate(Func>)	Registers an asynchronous validation action for an options type using a default failure message.
Validate(Func, String)	Registers a validation action for an options type.
Validate(Func>, String)	Registers an asynchronous validation action for an options type.
Validate(Func>, String)	Registers an asynchronous validation action for an options type.
Validate(Func, String)	Registers a validation action for an options type.
Validate(Func)	Registers a validation action for an options type using a default failure message.
Validate(Func>)	Registers an asynchronous validation action for an options type using a default failure message.
Validate(Func, String)	Registers a validation action for an options type.
Validate(Func>)	Registers an asynchronous validation action for an options type using a default failure message.
Validate(Func)	Registers a validation action for an options type using a default failure message.
Validate(Func>, String)	Registers an asynchronous validation action for an options type.
Validate(Func)	Registers a validation action for an options type using a default failure message.
Validate(Func>)	Registers an asynchronous validation action for an options type using a default failure message.
Validate(Func, String)	Registers a validation action for an options type.
Validate(Func>, String)	Registers an asynchronous validation action for an options type.
Validate(Func)	Registers a validation action for an options type using a default failure message.
Validate(Func>)	Registers an asynchronous validation action for an options type using a default failure message.
Validate(Func>, String)	Registers an asynchronous validation action for an options type.
Validate(Func, String)	Registers a validation action for an options type.
Validate(Func>, String)	Registers an asynchronous validation action for an options type.
Validate(Func>)	Registers an asynchronous validation action for an options type using a default failure message.
Validate(Func)	Registers a validation action for an options type using a default failure message.
Validate(Func, String)	Registers a validation action for an options type.
Validate()	Registers an IValidateOptions type for an options type.

Validate(Func)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type using a default failure message.

public:
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation);

abstract member Validate : Func<'Options, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate (validation As Func(Of TOptions, Boolean)) As OptionsBuilder(Of TOptions)

Parameters

validation: FuncBoolean>

The validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type using a default failure message.

public:
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation);

abstract member Validate : Func<'Options, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate (validation As Func(Of TOptions, CancellationToken, Task(Of Boolean))) As OptionsBuilder(Of TOptions)

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type.

public:
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation, string failureMessage);

abstract member Validate : Func<'Options, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate (validation As Func(Of TOptions, Boolean), failureMessage As String) As OptionsBuilder(Of TOptions)

Parameters

validation: FuncBoolean>

The validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type.

public:
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation, string failureMessage);

abstract member Validate : Func<'Options, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate (validation As Func(Of TOptions, CancellationToken, Task(Of Boolean)), failureMessage As String) As OptionsBuilder(Of TOptions)

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation, string failureMessage);

abstract member Validate : Func<'Options, 'Dep, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'Dep, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep) (validation As Func(Of TOptions, TDep, CancellationToken, Task(Of Boolean)), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep

The dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation, string failureMessage);

abstract member Validate : Func<'Options, 'Dep, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'Dep, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep) (validation As Func(Of TOptions, TDep, Boolean), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep

The dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation);

abstract member Validate : Func<'Options, 'Dep, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'Dep, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep) (validation As Func(Of TOptions, TDep, Boolean)) As OptionsBuilder(Of TOptions)

Type Parameters

TDep

The dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation);

abstract member Validate : Func<'Options, 'Dep, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'Dep, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep) (validation As Func(Of TOptions, TDep, CancellationToken, Task(Of Boolean))) As OptionsBuilder(Of TOptions)

Type Parameters

TDep

The dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4, TDep5) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, TDep5, Boolean), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

TDep5

The fifth dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4, TDep5) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, TDep5, CancellationToken, Task(Of Boolean))) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

TDep5

The fifth dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4, TDep5) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, TDep5, Boolean)) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

TDep5

The fifth dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, 'TDep5, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4, TDep5) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, TDep5, CancellationToken, Task(Of Boolean)), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

TDep5

The fifth dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, Boolean)) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, CancellationToken, Task(Of Boolean))) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, Boolean), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, 'TDep4, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3, TDep4) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, TDep4, CancellationToken, Task(Of Boolean)), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

TDep4

The fourth dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, Boolean)) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, CancellationToken, Task(Of Boolean))) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, CancellationToken, Task(Of Boolean)), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, 'TDep3, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2, TDep3) (validation As Func(Of TOptions, TDep1, TDep2, TDep3, Boolean), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

TDep3

The third dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2) (validation As Func(Of TOptions, TDep1, TDep2, CancellationToken, Task(Of Boolean)), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func>)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an asynchronous validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^> ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func> validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, System.Threading.CancellationToken, System.Threading.Tasks.Task (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2) (validation As Func(Of TOptions, TDep1, TDep2, CancellationToken, Task(Of Boolean))) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

Parameters

validation: FuncCancellationToken,Task<Boolean>>

The asynchronous validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type using a default failure message.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, bool (requires 'Options : null)> -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2) (validation As Func(Of TOptions, TDep1, TDep2, Boolean)) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate(Func, String)

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers a validation action for an options type.

public:
generic 
 virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate(Func ^ validation, System::String ^ failureMessage);

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate(Func validation, string failureMessage);

abstract member Validate : Func<'Options, 'TDep1, 'TDep2, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>
override this.Validate : Func<'Options, 'TDep1, 'TDep2, bool (requires 'Options : null)> * string -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)>

Public Overridable Function Validate(Of TDep1, TDep2) (validation As Func(Of TOptions, TDep1, TDep2, Boolean), failureMessage As String) As OptionsBuilder(Of TOptions)

Type Parameters

TDep1

The first dependency used by the validation function.

TDep2

The second dependency used by the validation function.

Parameters

validation: FuncBoolean>

The validation function.

failureMessage: String

The failure message to use when validation fails.

Returns

OptionsBuilder

The current OptionsBuilder.

Applies to

Validate()

Source:: OptionsBuilder.cs

Source:: OptionsBuilder.cs

Registers an IValidateOptions type for an options type.

public:
generic 
 where TValidateOptions : class, Microsoft::Extensions::Options::IValidateOptions virtual Microsoft::Extensions::Options::OptionsBuilder ^ Validate();

public virtual Microsoft.Extensions.Options.OptionsBuilder Validate() where TValidateOptions : class, Microsoft.Extensions.Options.IValidateOptions;

abstract member Validate : unit -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)> (requires 'ValidateOptions : null and 'ValidateOptions :> Microsoft.Extensions.Options.IValidateOptions<'Options>)
override this.Validate : unit -> Microsoft.Extensions.Options.OptionsBuilder<'Options (requires 'Options : null)> (requires 'ValidateOptions : null and 'ValidateOptions :> Microsoft.Extensions.Options.IValidateOptions<'Options>)

Public Overridable Function Validate(Of TValidateOptions As {Class, IValidateOptions(Of TOptions)}) () As OptionsBuilder(Of TOptions)

Type Parameters

TValidateOptions

The validation type.

Returns

OptionsBuilder

The current OptionsBuilder.

Remarks

Validation is scoped to the options name associated with this builder. Dependencies required by TValidateOptions are resolved from the service provider. This method is the preferred way to register a validator type because it preserves the builder's options name for startup validation. A validator registered directly as IValidateOptions is conservatively treated as applying to every options name.

Applies to

Feedback

Was this page helpful?