ISettingsWriter Interface
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
As alterações feitas por meio dessa API não entrarão em vigor até RequestCommit(String) que seja chamada. Nesse ponto, eles podem ser imediatamente aprovados/rejeitados ou talvez precisem aguardar a aprovação do usuário. O escopo no qual as alterações são mantidas pode ser determinado pelo usuário. RequestCommit(String) pode ser chamado várias vezes.
public interface ISettingsWriter : Microsoft.VisualStudio.Utilities.UnifiedSettings.ISettingsReader
type ISettingsWriter = interface
interface ISettingsReader
Public Interface ISettingsWriter
Implements ISettingsReader
- Implementações
Métodos
Commit(String) |
Obsoleto.
Esse método é preterido. Use RequestCommit(String) em vez disso. Confirma todas as alterações na fila. Isso pode exigir a aprovação do usuário para ser concluída. Nesse caso, esse método retornará imediatamente e o commit será concluído posteriormente depois que o usuário o tiver aprovado. |
EnqueueArrayChange<T>(String, IReadOnlyList<T>) |
Enfileira uma alteração no valor de uma configuração de matriz. O escopo de destino pode ser selecionado pelo usuário durante o processo de aprovação. A validação será executada, a menos que a configuração não esteja registrada. |
EnqueueChange<T>(String, T) |
Enfileira uma alteração no valor de uma configuração. O escopo de destino pode ser selecionado pelo usuário durante o processo de aprovação. A validação será executada, a menos que a configuração não esteja registrada. Isso é equivalente a chamar EnqueueChange<T>(String, T, SettingWriteOptions) com None. |
EnqueueChange<T>(String, T, SettingWriteOptions) |
Enfileira uma alteração no valor de uma configuração. O escopo de destino pode ser selecionado pelo usuário durante o processo de aprovação. A validação será executada, a menos que a configuração não esteja registrada. |
GetArray<T>(String, SettingReadOptions) |
Obtém o valor efetivo de uma configuração de matriz ou o valor padrão se ele não for personalizado. (Herdado de ISettingsReader) |
GetArrayOrThrow<T>(String) |
Obtém uma configuração de matriz. Se não houver nenhum valor persistente, o valor persistente será inválido ou o valor persistente não poderá ser convertido em uma matriz de |
GetValue<T>(String, SettingReadOptions) |
Obtém o valor efetivo de uma configuração não matriz ou o valor padrão se ele não for personalizado. (Herdado de ISettingsReader) |
GetValueOrThrow<T>(String) |
Obtém uma configuração que não é de matriz. Se não houver nenhum valor persistente, o valor persistente será inválido ou o valor persistente não poderá ser convertido |
RequestCommit(String) |
Solicita um commit de todas as alterações na fila. Isso pode exigir a aprovação do usuário para ser concluída. Nesse caso, esse método retornará imediatamente e o commit será concluído posteriormente depois que o usuário o tiver aprovado. As alterações serão aplicadas no escopo selecionado pelo usuário. |
SubscribeToChanges(Action<SettingsUpdate>, String[]) |
Registra um retorno de chamada a ser invocado quando os valores efetivos das configurações são alterados. Observe que uma configuração pode ser alterada sem afetar seu valor efetivo se a configuração for substituída em um escopo de prioridade mais alta , por exemplo, se uma alteração de configuração for aplicada ao escopo do "usuário" (prioridade mais baixa), mas a mesma configuração também for personalizada no escopo "workspace" (prioridade mais alta), a alteração não afetará o valor efetivo. (Herdado de ISettingsReader) |