Método IVsSettingsWriter.WriteSettingString (String, String)

Artigo
01/24/2017

Publicado: junho de 2016

Armazena um valor de cadeia de caracteres no 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

int WriteSettingString(
    string pszSettingName,
    string pszSettingValue
)

int WriteSettingString(
    String^ pszSettingName,
    String^ pszSettingValue
)

abstract WriteSettingString : 
        pszSettingName:string *
        pszSettingValue:string -> int

Function WriteSettingString (
    pszSettingName As String,
    pszSettingValue As String
) As Integer

Parâmetros

pszSettingName
Type: System.String

[in] Cadeia de caracteres que identifica exclusivamente o elemento de dados a serem armazenados

pszSettingValue
Type: System.String

[in] Cadeia de caracteres a ser armazenado como o elemento de dados especificado a Visual Studio arquivo de configurações.

Valor Retornado

Type: System.Int32

Se o método for bem-sucedido, ele retornará S_OK. Se ele falhar, ele retorna um código de erro.

Comentários

COM assinatura

De vsshell80.idl:

HRESULT WriteSettingString(
   LPCOLESTR pszSettingName, 
   LPCOLESTR pszSettingValue
);

Os nomes especificados pelo pfSettingValue precisa ser exclusivo dentro de um ponto de configurações personalizado (configurações de categoria), como o IDE usa o ponto de configurações personalizado Identificação GUID e o valor de pfSettingValue para identificar cada configuração salva.

Se mais de um IVsSettingsWriter método for chamado com o mesmo valor de pszSettingName, o valor original é substituído no Visual Studio arquivo de configurações.

Porque o valor de pfSettingValue deve ser exclusivo, a ordem de chamada WriteSettingString em relação a outros métodos de IVsSettingsReader interface não é relevante.

Confira Também

IVsSettingsReader
IVsSettingsWriter
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

Partilhar via