Função SHQueryValueExA (shlwapi.h)

Abre uma chave do Registro e a consulta para obter um valor específico.

Sintaxe

LSTATUS SHQueryValueExA(
  [in]                HKEY   hkey,
  [in, optional]      LPCSTR pszValue,
                      DWORD  *pdwReserved,
  [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] pszValue

Tipo: LPCTSTR

O endereço da cadeia de caracteres terminada em nulo que contém o nome do valor a ser consultado.

pdwReserved

Tipo: LPDWORD

Reservado. Deve ser NULL.

[out, optional] pdwType

Tipo: LPDWORD

O endereço da variável que recebe o tipo de valor da chave. Para obter mais informações, consulte Tipos de dados do Registro.

[out, optional] pvData

Tipo: LPVOID

O endereço do buffer que recebe os dados do valor. Esse parâmetro poderá ser NULL se os dados não forem necessários.

[in, out, optional] pcbData

Tipo: LPDWORD

O endereço da variável que especifica o tamanho, em bytes, do buffer apontado pelo parâmetro pvData . Quando a função retorna, essa variável contém o tamanho dos dados copiados para pvData.

Retornar valor

Tipo: DWORD

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.

Comentários

Observação

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

Requisitos

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