ISettingsWriter インターフェイス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
この API を介して行われた変更は、 が呼び出されるまで RequestCommit(String) 有効になりません。 その時点で、すぐに承認または拒否されるか、ユーザーの承認を待つ必要がある場合があります。 変更が永続化されるスコープは、ユーザーによって決定される場合があります。 RequestCommit(String) は複数回呼び出すことができます。
public interface ISettingsWriter : Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsReadertype ISettingsWriter = interface
interface ISettingsReaderPublic Interface ISettingsWriter
Implements ISettingsReader- 実装
メソッド
| Commit(String) |
古い.
このメソッドは非推奨とされます。 代わりに RequestCommit(String) を使用してください キューに登録されたすべての変更をコミットします。 これを完了するには、ユーザーの承認が必要な場合があります。 その場合、このメソッドはすぐにが返され、コミットはユーザーが承認すると後で完了します。 |
| EnqueueArrayChange<T>(String, IReadOnlyList<T>) |
配列設定の値に対する変更をエンキューします。 承認プロセス中にユーザーがターゲット スコープを選択できます。 設定が登録されていない限り、検証が実行されます。 |
| EnqueueChange<T>(String, T) |
設定の値に対する変更をエンキューします。 承認プロセス中にユーザーがターゲット スコープを選択できます。 設定が登録されていない限り、検証が実行されます。 これは、 で を呼び出すこと EnqueueChange<T>(String, T, SettingWriteOptions) と None同じです。 |
| EnqueueChange<T>(String, T, SettingWriteOptions) |
設定の値に対する変更をエンキューします。 承認プロセス中にユーザーがターゲット スコープを選択できます。 設定が登録されていない限り、検証が実行されます。 |
| GetArray<T>(String, SettingReadOptions) |
配列設定の有効な値を取得します。カスタマイズされていない場合は既定値を取得します。 (継承元 ISettingsReader) |
| GetArrayOrThrow<T>(String) |
配列の設定を取得します。 永続化された値がない場合、永続化された値が無効であるか、永続化された値を の |
| GetValue<T>(String, SettingReadOptions) |
配列以外の設定の有効な値を取得します。カスタマイズされていない場合は既定値を取得します。 (継承元 ISettingsReader) |
| GetValueOrThrow<T>(String) |
配列以外の設定を取得します。 永続化された値がない場合、永続化された値が無効であるか、永続化された値を に |
| RequestCommit(String) |
キューに登録されているすべての変更のコミットを要求します。 これを完了するには、ユーザーの承認が必要な場合があります。 その場合、このメソッドはすぐにが返され、コミットはユーザーが承認すると後で完了します。 変更は、ユーザーが選択したスコープに適用されます。 |
| SubscribeToChanges(Action<SettingsUpdate>, String[]) |
設定の有効な値が変更されたときに呼び出されるコールバックを登録します。 設定が優先度の高いスコープでオーバーライドされた場合 (たとえば、設定の変更が "ユーザー" スコープ (優先度の低い) に適用されているが、同じ設定が "ワークスペース" スコープ (優先度が高い) でもカスタマイズされている場合など)、有効な値に影響を与えずに設定が変更される可能性があることに注意してください。この変更は有効な値には影響しません。 (継承元 ISettingsReader) |