Método IVsSettingsReader.ReadSettingBytes (String, Byte, Int32, Int32)

Artigo
01/24/2017

Publicado: abril de 2016

Retorna os valores de uma matriz armazenados 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 ReadSettingBytes(
    string pszSettingName,
    ref byte pSettingValue,
    out int plDataLength,
    int lDataMax
)

int ReadSettingBytes(
    String^ pszSettingName,
    unsigned char% pSettingValue,
    [OutAttribute] int% plDataLength,
    int lDataMax
)

abstract ReadSettingBytes : 
        pszSettingName:string *
        pSettingValue:byte byref *
        plDataLength:int byref *
        lDataMax:int -> int

Function ReadSettingBytes (
    pszSettingName As String,
    ByRef pSettingValue As Byte,
    <OutAttribute> ByRef plDataLength As Integer,
    lDataMax As Integer
) As Integer

Parâmetros

pszSettingName
Type: System.String

[in] Cadeia de caracteres identificando exclusivamente o elemento de dados a serem recuperados.

pSettingValue
Type: System.Byte

[no, out] Buffer para receber dados bytes recuperado do elemento de dados especificado a Visual Studio arquivo de configurações.

plDataLength
Type: System.Int32

[out] Número de valores de bytes retornados.

lDataMax
Type: System.Int32

[in] Número máximo de bytes a serem retornados. Se o tamanho dos dados armazenados é maior que lDataMax, um erro será retornado.

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

O valor de plDataLength sempre deve ser menor ou igual a lDataMax.

Qualquer buffer usado para receber os dados recuperados (pSettingValue) deve ser pelo menos lDataMax bytes de tamanho.

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

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

Confira Também

IVsSettingsReader
IVsSettingsWriter
ImportSettings
Namespace Microsoft.VisualStudio.Shell.Interop
Suporte para configurações de usuário
Como: usar Assemblies de interoperabilidade para importar configurações
Importando configurações
Working with Settings

Retornar ao início

Partilhar via