ISettingsWriter Interface

Définition

Les modifications apportées via cette API ne prennent pas effet tant qu’elles n’ont RequestCommit(String) pas été appelées. À ce stade, ils peuvent être immédiatement approuvés/rejetés ou ils peuvent avoir besoin d’attendre l’approbation de l’utilisateur. L’étendue à laquelle les modifications sont conservées peut être déterminée par l’utilisateur. RequestCommit(String) peut être appelé plusieurs fois.

public interface ISettingsWriter : Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsReader
type ISettingsWriter = interface
    interface ISettingsReader
Public Interface ISettingsWriter
Implements ISettingsReader
Implémente

Méthodes

Commit(String)
Obsolète.

Cette méthode est déconseillée. Utilisez RequestCommit(String) à la place. Valide toutes les modifications mises en file d’attente. Cela peut nécessiter l’approbation de l’utilisateur. Dans ce cas, cette méthode retourne immédiatement et la validation se termine plus tard une fois que l’utilisateur l’a approuvée.

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

Met en file d’attente une modification de la valeur d’un paramètre de tableau. L’étendue cible peut être sélectionnée par l’utilisateur pendant le processus d’approbation. La validation est effectuée, sauf si le paramètre n’est pas inscrit.

EnqueueChange<T>(String, T)

Met en file d’attente une modification de la valeur d’un paramètre. L’étendue cible peut être sélectionnée par l’utilisateur pendant le processus d’approbation. La validation est effectuée, sauf si le paramètre n’est pas inscrit. Cela équivaut à appeler EnqueueChange<T>(String, T, SettingWriteOptions) avec None.

EnqueueChange<T>(String, T, SettingWriteOptions)

Met en file d’attente une modification de la valeur d’un paramètre. L’étendue cible peut être sélectionnée par l’utilisateur pendant le processus d’approbation. La validation est effectuée, sauf si le paramètre n’est pas inscrit.

GetArray<T>(String, SettingReadOptions)

Obtient la valeur effective d’un paramètre de tableau, ou la valeur par défaut si elle n’est pas personnalisée.

(Hérité de ISettingsReader)
GetArrayOrThrow<T>(String)

Obtient un paramètre de tableau. S’il n’existe aucune valeur persistante, la valeur persistante n’est pas valide ou la valeur persistante ne peut pas être convertie en tableau de T, retourne la valeur par défaut.

(Hérité de ISettingsReader)
GetValue<T>(String, SettingReadOptions)

Obtient la valeur effective d’un paramètre non-tableau, ou la valeur par défaut si elle n’est pas personnalisée.

(Hérité de ISettingsReader)
GetValueOrThrow<T>(String)

Obtient un paramètre autre que le tableau. S’il n’existe aucune valeur persistante, la valeur persistante n’est pas valide ou la valeur persistante ne peut pas être convertie Ten , retourne la valeur par défaut.

(Hérité de ISettingsReader)
RequestCommit(String)

Demande une validation de toutes les modifications mises en file d’attente. Cela peut nécessiter l’approbation de l’utilisateur. Dans ce cas, cette méthode retourne immédiatement et la validation se termine plus tard une fois que l’utilisateur l’a approuvée. Les modifications seront appliquées dans l’étendue sélectionnée par l’utilisateur.

SubscribeToChanges(Action<SettingsUpdate>, String[])

Inscrit un rappel à appeler lorsque les valeurs effectives des paramètres changent. Notez qu’un paramètre peut changer sans affecter sa valeur effective si le paramètre est remplacé dans une étendue de priorité plus élevée, par exemple, si une modification de paramètre est appliquée à l’étendue « utilisateur » (priorité inférieure), mais que le même paramètre est également personnalisé au niveau de l’étendue « espace de travail » (priorité plus élevée), la modification n’affecte pas la valeur effective.

(Hérité de ISettingsReader)

S’applique à