Freigeben über


ISettingsWriter Schnittstelle

Definition

Über diese API vorgenommene Änderungen werden erst wirksam, wenn RequestCommit(String) aufgerufen wird. An diesem Punkt können sie sofort genehmigt/abgelehnt werden, oder sie müssen möglicherweise auf die Benutzergenehmigung warten. Der Bereich, in dem die Änderungen beibehalten werden, kann vom Benutzer bestimmt werden. RequestCommit(String) kann mehrmals aufgerufen werden.

public interface ISettingsWriter : Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsReader
type ISettingsWriter = interface
    interface ISettingsReader
Public Interface ISettingsWriter
Implements ISettingsReader
Implementiert

Methoden

Commit(String)
Veraltet.

Diese Methode ist als veraltet markiert. Verwenden Sie stattdessen RequestCommit(String). Committent alle Änderungen in der Warteschlange. Dies kann eine Benutzergenehmigung erfordern. In diesem Fall wird diese Methode sofort zurückgegeben, und der Commit wird später abgeschlossen, nachdem der Benutzer sie genehmigt hat.

EnqueueArrayChange<T>(String, IReadOnlyList<T>)

Stellt eine Änderung des Werts einer Arrayeinstellung in die Warteschlange. Der Zielbereich kann vom Benutzer während des Genehmigungsprozesses ausgewählt werden. Die Überprüfung wird ausgeführt, es sei denn, die Einstellung ist nicht registriert.

EnqueueChange<T>(String, T)

Stellt eine Änderung des Werts einer Einstellung in die Warteschlange. Der Zielbereich kann vom Benutzer während des Genehmigungsprozesses ausgewählt werden. Die Überprüfung wird ausgeführt, es sei denn, die Einstellung ist nicht registriert. Dies entspricht dem Aufrufen EnqueueChange<T>(String, T, SettingWriteOptions) von mit None.

EnqueueChange<T>(String, T, SettingWriteOptions)

Stellt eine Änderung des Werts einer Einstellung in die Warteschlange. Der Zielbereich kann vom Benutzer während des Genehmigungsprozesses ausgewählt werden. Die Überprüfung wird ausgeführt, es sei denn, die Einstellung ist nicht registriert.

GetArray<T>(String, SettingReadOptions)

Ruft den effektiven Wert einer Arrayeinstellung oder den Standardwert ab, wenn er nicht angepasst ist.

(Geerbt von ISettingsReader)
GetArrayOrThrow<T>(String)

Ruft eine Arrayeinstellung ab. Wenn kein dauerhafter Wert vorhanden ist, der persistente Wert ungültig ist oder der persistente Wert nicht in ein Array von Tkonvertiert werden kann, gibt den Standardwert zurück.

(Geerbt von ISettingsReader)
GetValue<T>(String, SettingReadOptions)

Ruft den effektiven Wert einer Nicht-Arrayeinstellung oder den Standardwert ab, wenn er nicht angepasst ist.

(Geerbt von ISettingsReader)
GetValueOrThrow<T>(String)

Ruft eine Nicht-Array-Einstellung ab. Wenn kein dauerhafter Wert vorhanden ist, der persistente Wert ungültig ist oder der persistente Wert nicht in Tkonvertiert werden kann, gibt den Standardwert zurück.

(Geerbt von ISettingsReader)
RequestCommit(String)

Fordert einen Commit aller Änderungen in der Warteschlange an. Dies kann eine Benutzergenehmigung erfordern. In diesem Fall wird diese Methode sofort zurückgegeben, und der Commit wird später abgeschlossen, nachdem der Benutzer sie genehmigt hat. Änderungen werden in dem vom Benutzer ausgewählten Bereich angewendet.

SubscribeToChanges(Action<SettingsUpdate>, String[])

Registriert einen Rückruf, der aufgerufen werden soll, wenn sich die effektiven Werte der Einstellungen ändern. Beachten Sie, dass sich eine Einstellung ändern kann, ohne ihren effektiven Wert zu beeinträchtigen, wenn die Einstellung in einem Bereich mit höherer Priorität überschrieben wird. Wenn z. B. eine Einstellungsänderung auf den Bereich "Benutzer" (niedrigere Priorität) angewendet wird, die gleiche Einstellung aber auch im Arbeitsbereichsbereich (höhere Priorität) angepasst wird, wirkt sich die Änderung nicht auf den effektiven Wert aus.

(Geerbt von ISettingsReader)

Gilt für: