Função SHGetValueA (shlwapi.h)

Artigo
11/20/2024

Recupera um valor do Registro.

Sintaxe

LSTATUS SHGetValueA(
  [in]                HKEY   hkey,
  [in, optional]      LPCSTR pszSubKey,
  [in, optional]      LPCSTR pszValue,
  [out, optional]     DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out, optional] DWORD  *pcbData
);

Parâmetros

[in] hkey

Tipo: HKEY

Um identificador para a chave aberta no momento ou qualquer um dos valores predefinidos a seguir.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in, optional] pszSubKey

Tipo: LPCTSTR

O endereço de uma cadeia de caracteres terminada em nulo que especifica o nome da subchave da qual recuperar o valor.

[in, optional] pszValue

Tipo: LPCTSTR

O endereço do valor.

[out, optional] pdwType

Tipo: LPDWORD

O tipo de valor. Para obter mais informações, consulte tipos de dados do Registro.

[out, optional] pvData

Tipo: LPVOID

O endereço do buffer de dados de destino.

[in, out, optional] pcbData

Tipo: LPDWORD

O tamanho do buffer de dados de destino.

Valor de retorno

Tipo: LSTATUS

Retorna ERROR_SUCCESS se tiver êxito ou um código de erro diferente de zero definido em Winerror.h caso contrário. Você pode usar a função FormatMessage com o sinalizador FORMAT_MESSAGE_FROM_SYSTEM para recuperar uma descrição genérica do erro.

Observações

Se o aplicativo precisar definir/recuperar uma série de valores na mesma chave, é melhor abrir a chave uma vez e definir/recuperar os valores com as funções regulares do Registro do Microsoft Win32 em vez de usar essa função repetidamente.

Nota

O cabeçalho shlwapi.h define SHGetValue como um alias que seleciona automaticamente a versão ANSI ou Unicode dessa função com base na definição da constante do pré-processador UNICODE. A combinação do uso do alias neutro de codificação com código que não é neutro em codificação pode levar a incompatibilidades que resultam em erros de compilação ou de runtime. Para obter mais informações, consulte Conventions for Function Prototypes.

Requisitos

Requisito	Valor
de cliente com suporte mínimo	Windows 2000 Professional, Windows XP [somente aplicativos da área de trabalho]
servidor com suporte mínimo	Windows 2000 Server [somente aplicativos da área de trabalho]
da Plataforma de Destino	Windows
cabeçalho	shlwapi.h
biblioteca	Shlwapi.lib
de DLL	Shlwapi.dll (versão 4.71 ou posterior)

Compartilhar via