IOptionsSnapshot<TOptions> Interface

Reference

Definition

Namespace:: Microsoft.Extensions.Options

Assembly:: Microsoft.Extensions.Options.dll

Package:: Microsoft.Extensions.Options v6.0.0

Package:: Microsoft.Extensions.Options v7.0.0

Package:: Microsoft.Extensions.Options v8.0.0

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.

Used to access the value of TOptions for the lifetime of a request.

generic <typename TOptions>
public interface class IOptionsSnapshot

generic <typename TOptions>
 where TOptions : class, gcnew()public interface class IOptionsSnapshot : Microsoft::Extensions::Options::IOptions<TOptions>

generic <typename TOptions>
 where TOptions : classpublic interface class IOptionsSnapshot : Microsoft::Extensions::Options::IOptions<TOptions>

public interface IOptionsSnapshot<out TOptions>

public interface IOptionsSnapshot<out TOptions> : Microsoft.Extensions.Options.IOptions<out TOptions> where TOptions : class, new()

public interface IOptionsSnapshot<out TOptions> : Microsoft.Extensions.Options.IOptions<out TOptions> where TOptions : class

type IOptionsSnapshot<'Options> = interface

type IOptionsSnapshot<'Options (requires 'Options : null and 'Options : (new : unit -> 'Options))> = interface
    interface IOptions<'Options (requires 'Options : null and 'Options : (new : unit -> 'Options))>

type IOptionsSnapshot<'Options (requires 'Options : null)> = interface
    interface IOptions<'Options (requires 'Options : null)>

Public Interface IOptionsSnapshot(Of Out TOptions)

Public Interface IOptionsSnapshot(Of Out TOptions)
Implements IOptions(Of Out TOptions)

Type Parameters

TOptions

Options type.

This type parameter is covariant. That is, you can use either the type you specified or any type that is more derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.