ISettingsWriter Interfejs
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
Zmiany wprowadzone za pośrednictwem tego interfejsu API nie będą obowiązywać do momentu RequestCommit(String) wywołania. W tym momencie mogą one zostać natychmiast zatwierdzone/odrzucone lub może być konieczne oczekiwanie na zatwierdzenie użytkownika. Zakres, w którym zmiany są utrwalane, mogą być określane przez użytkownika. RequestCommit(String) może być wywoływana wiele razy.
public interface ISettingsWriter : Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsReadertype ISettingsWriter = interface
interface ISettingsReaderPublic Interface ISettingsWriter
Implements ISettingsReader- Implementuje
Metody
| Commit(String) |
Przestarzałe.
Ta metoda jest przestarzała. Zamiast tego użyj polecenia cmdlet RequestCommit(String). Zatwierdza wszystkie zmiany w kolejce. Może to wymagać zatwierdzenia przez użytkownika. W takim przypadku ta metoda zostanie zwrócona natychmiast, a zatwierdzenie zostanie zakończone później po zatwierdzeniu go przez użytkownika. |
| EnqueueArrayChange<T>(String, IReadOnlyList<T>) |
Kolejkuje zmianę do wartości ustawienia tablicy. Zakres docelowy może zostać wybrany przez użytkownika podczas procesu zatwierdzania. Walidacja zostanie przeprowadzona, chyba że ustawienie nie zostanie zarejestrowane. |
| EnqueueChange<T>(String, T) |
Kolejkuje zmianę do wartości ustawienia. Zakres docelowy może zostać wybrany przez użytkownika podczas procesu zatwierdzania. Walidacja zostanie przeprowadzona, chyba że ustawienie nie zostanie zarejestrowane. Jest to równoważne wywołaniu EnqueueChange<T>(String, T, SettingWriteOptions) za pomocą polecenia None. |
| EnqueueChange<T>(String, T, SettingWriteOptions) |
Kolejkuje zmianę do wartości ustawienia. Zakres docelowy może zostać wybrany przez użytkownika podczas procesu zatwierdzania. Walidacja zostanie przeprowadzona, chyba że ustawienie nie zostanie zarejestrowane. |
| GetArray<T>(String, SettingReadOptions) |
Pobiera efektywną wartość ustawienia tablicy lub wartość domyślną, jeśli nie jest ona dostosowywana. (Odziedziczone po ISettingsReader) |
| GetArrayOrThrow<T>(String) |
Pobiera ustawienie tablicy. Jeśli nie ma utrwalonej wartości, utrwalonej wartości jest nieprawidłowa lub nie można przekonwertować utrwalonej wartości na tablicę , |
| GetValue<T>(String, SettingReadOptions) |
Pobiera efektywną wartość ustawienia innego niż tablica lub wartość domyślną, jeśli nie jest ona dostosowywana. (Odziedziczone po ISettingsReader) |
| GetValueOrThrow<T>(String) |
Pobiera ustawienie inne niż tablica. Jeśli nie ma utrwalonej wartości, utrwalonej wartości jest nieprawidłowa lub nie można przekonwertować utrwalonej wartości na |
| RequestCommit(String) |
Żąda zatwierdzenia wszystkich zmian w kolejce. Może to wymagać zatwierdzenia przez użytkownika. W takim przypadku ta metoda zostanie zwrócona natychmiast, a zatwierdzenie zostanie zakończone później po zatwierdzeniu go przez użytkownika. Zmiany zostaną zastosowane w zakresie wybranym przez użytkownika. |
| SubscribeToChanges(Action<SettingsUpdate>, String[]) |
Rejestruje wywołanie zwrotne, które ma być wywoływane, gdy obowiązujące wartości ustawień zmieniają się. Należy pamiętać, że ustawienie może ulec zmianie bez wpływu na obowiązującą wartość, jeśli ustawienie zostanie zastąpione w zakresie o wyższym priorytcie — np. jeśli zmiana ustawienia zostanie zastosowana do zakresu "użytkownika" (niższego priorytetu), ale to samo ustawienie jest również dostosowane w zakresie "obszar roboczy" (wyższy priorytet), zmiana nie wpłynie na obowiązującą wartość. (Odziedziczone po ISettingsReader) |