OptionsMonitorExtensions.OnChange<TOptions> Method

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

Package:: Microsoft.Extensions.Options v9.0.0-preview.2.24128.5

Source:: OptionsMonitorExtensions.cs

Source:: OptionsMonitorExtensions.cs

Source:: OptionsMonitorExtensions.cs

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.

Registers a listener to be called whenever TOptions changes.

public:
generic <typename TOptions>
[System::Runtime::CompilerServices::Extension]
 static IDisposable ^ OnChange(Microsoft::Extensions::Options::IOptionsMonitor<TOptions> ^ monitor, Action<TOptions> ^ listener);

public static IDisposable OnChange<TOptions> (this Microsoft.Extensions.Options.IOptionsMonitor<TOptions> monitor, Action<TOptions> listener);

public static IDisposable? OnChange<TOptions> (this Microsoft.Extensions.Options.IOptionsMonitor<TOptions> monitor, Action<TOptions> listener);

static member OnChange : Microsoft.Extensions.Options.IOptionsMonitor<'Options> * Action<'Options> -> IDisposable

<Extension()>
Public Function OnChange(Of TOptions) (monitor As IOptionsMonitor(Of TOptions), listener As Action(Of TOptions)) As IDisposable

Type Parameters

TOptions

The type of options instance being monitored.

Parameters

monitor: IOptionsMonitor<TOptions>

The options monitor.

listener: Action<TOptions>

The action to be invoked when TOptions has changed.

Returns

IDisposable

An IDisposable which should be disposed to stop listening for changes.

Applies to