ISettingsReader.SubscribeToChanges メソッド

定義

名前空間:

Microsoft.VisualStudio.Utilities.UnifiedSettings

アセンブリ:

Microsoft.VisualStudio.Utilities.dll

パッケージ:

Microsoft.VisualStudio.Utilities v17.12.40391

設定の有効な値が変更されたときに呼び出されるコールバックを登録します。 設定が優先度の高いスコープでオーバーライドされた場合 (たとえば、設定の変更が "ユーザー" スコープ (優先度の低い) に適用されているが、同じ設定が "ワークスペース" スコープ (優先度が高い) でもカスタマイズされている場合など)、有効な値に影響を与えずに設定が変更される可能性があることに注意してください。この変更は有効な値には影響しません。

public IDisposable SubscribeToChanges (Action<Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingsUpdate> handler, params string[] monikerPatterns);

abstract member SubscribeToChanges : Action<Microsoft.VisualStudio.Utilities.UnifiedSettings.SettingsUpdate> * string[] -> IDisposable

Public Function SubscribeToChanges (handler As Action(Of SettingsUpdate), ParamArray monikerPatterns As String()) As IDisposable

パラメーター

handler

Action<SettingsUpdate>

設定が変更されたときに呼び出されるコールバック。

monikerPatterns

String[]

このコールバックをトリガーする設定を表す設定モニカー ("environment.general.visualExperience.colorTheme" など) またはプレフィックス + ワイルドカード ("environment.general.*"など) のコレクション。

戻り値

IDisposable

破棄時にこのハンドラーの登録を解除するオブジェクト。

例外

ArgumentNullException

または monikerPatterns が null の場合handlerにスローされます。

ArgumentException

が空の場合 monikerPatterns にスローされます。