Interface IVsSettingsWriter

Artigo
01/24/2017

Publicado: abril de 2016

Fornece um mecanismo para armazenar informações de configuração de VSPackages o Visual Studio arquivo de configurações.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (em Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Sintaxe

[GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")]
[InterfaceTypeAttribute(1)]
public interface IVsSettingsWriter

[GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")]
[InterfaceTypeAttribute(1)]
public interface class IVsSettingsWriter

[<GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")>]
[<InterfaceTypeAttribute(1)>]
type IVsSettingsWriter = interface end

<GuidAttribute("0F1CF980-AFC6-406E-958D-7F24287E3916")>
<InterfaceTypeAttribute(1)>
Public Interface IVsSettingsWriter

Métodos

	Nome	Descrição
	ReportError(String, UInt32)	Relata o status de erro da operação de gravação de arquivo de configurações.
	WriteCategoryVersion(Int32, Int32, Int32, Int32)	Define o valor de um objeto de versão de categoria armazenado no Visual Studio arquivo de configurações.
	WriteSettingAttribute(String, String, String)
	WriteSettingBoolean(String, Int32)	Armazena o valor de um objeto booliano no Visual Studio arquivo de configurações.
	WriteSettingBytes(String, Byte[], Int32)	Armazena os valores de uma matriz de Visual Studio arquivo de configurações.
	WriteSettingLong(String, Int32)	Armazena o valor de um objeto longo no Visual Studio arquivo de configurações.
	WriteSettingString(String, String)	Armazena um valor de cadeia de caracteres no Visual Studio arquivo de configurações.
	WriteSettingXml(Object)	Armazena o valor de um objeto XML a Visual Studio arquivo de configurações.
	WriteSettingXmlFromString(String)	Armazena o valor de uma configuração XML como um objeto de cadeia de caracteres no Visual Studio arquivo de configurações.

Comentários

Essa interface é implementada pelo ambiente.

Observações para chamadores

Chamar IVsSettingsWriter ao armazenar informações de configuração do VSPackage para o Visual Studio arquivo de configurações.

Observações para implementadores

Somente os VSPackages que registrou o seu suporte a Visual Studio configurações do mecanismo de fazer usam de IVsSettingsWriter. Para obter mais informações sobre como registrar um VSPackage como suporte a Visual Studio mecanismo de configurações, consulte suporte para configurações de usuário.

Quando uma operação de exportação de configuração foi selecionada o configurações de importação/exportação recurso disponível no IDE do ferramentas menu, o ambiente passa um IVsSettingsWriter interface para o método de exportação de configurações do VSPackage, que usa a interface para gravar dados de configuração. O SDK do Visual Studio oferece suporte a vários métodos de exportação:

Assembly de interoperabilidade com base VSPackages, o método de exportação é a implementação do VSPackage do IVsUserSettings da interface ExportSettings.
Para a maioria das estrutura de pacote gerenciado com base em VSPackages, o método de exportação é a implementação do VSPackage do IProfileManager da interface SaveSettingsToXml.
Estrutura de pacote gerenciado com base VSPackages Implementando o DialogPage interface, o método de exportação é a interface SaveSettingsToXml.

Para obter mais informações, consulte como: exportar configurações por usando Assemblies de interoperabilidade ou Exportando configurações.

Observação
Além de todos os dados armazenados usando IVsSettingsWriter métodos, o IDE sempre transparentemente armazena a versão do Visual Studio usado para exportar dados de configuração.

Observação
Prática recomendada para armazenar buffers ou cadeia de caracteres é salvar o tamanho do buffer armazenado ou cadeia de caracteres, bem como o próprio objeto. Essas informações de tamanho sempre devem ser usadas ao recuperar o buffer salvo de cadeia de caracteres para evitar estouros de buffer.

Exemplos

No exemplo a seguir é um método chamado por uma implementação de ExportSettings, o método grava valores de três configurações, um dos quais é o tamanho de um buffer a ser armazenado.

HRESULT ExportSettings_CommandBars(IVsSettingsWriter *pSettings)
{
    if (!pSettings)
        return E_INVALIDARG;

    hr = pSettings->WriteSettingString(c_szFirstSettingName, L"Value1");
    IfFailGo(hr);

    int cRandomTrash = 12345;
    BYTE *pRandomTrash = (BYTE *)VSAlloc(cRandomTrash);
    if (pRandomTrash){
        hr = pSettings->WriteSettingBytes(c_szRandomTrashBytes, pRandomTrash, cRandomTrash);
        IfFailGo(hr);
        hr = pSettings->WriteSettingLong(c_szRandomTrashLength, cRandomTrash);
        IfFailGo(hr);
    }

 Error:
    return hr;
};

Confira Também

IVsSettingsReader
ExportSettings
Namespace Microsoft.VisualStudio.Shell.Interop
Suporte para configurações de usuário
Como: exportar configurações usando Assemblies de interoperabilidade
Exportando configurações
Working with Settings

Retornar ao início

Compartilhar via