Compartilhar via

Função SHEnumValueA (shlwapi.h)

  • Artigo

Enumera os valores da chave do Registro aberta especificada.

Sintaxe

LSTATUS SHEnumValueA(
  [in]                HKEY    hkey,
  [in]                DWORD   dwIndex,
                      PSTR    pszValueName,
  [in, out, optional] LPDWORD pcchValueName,
  [out, optional]     LPDWORD pdwType,
                      void    *pvData,
  [in, out, optional] LPDWORD 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] dwIndex

Tipo: DWORD

O índice do valor a ser recuperado. Esse parâmetro deve ser zero para a primeira chamada e incrementado para chamadas subsequentes.

pszValueName

Tipo: LPTSTR

O endereço de um buffer de caracteres que recebe o nome do valor enumerado. O tamanho desse buffer é especificado em pcchValueName.

[in, out, optional] pcchValueName

Tipo: LPDWORD

O endereço de um DWORD que, na entrada, contém o tamanho do buffer em pszValueName, em caracteres. Na saída, isso contém o número de caracteres que foram copiados para pszValueName.

[out, optional] pdwType

Tipo: LPDWORD

O endereço de um DWORD que recebe o tipo de dados do valor. Esses são os mesmos valores descritos no parâmetro lpType de RegEnumValue.

pvData

Tipo: LPVOID

O endereço de um buffer que recebe os dados da entrada de valor. O tamanho desse buffer é especificado em pcbData. Esse parâmetro poderá ser NULL se os dados não forem necessários.

[in, out, optional] pcbData

Tipo: LPDWORD

O endereço de um DWORD que, na entrada, contém o tamanho do buffer em pvData, em bytes. Na saída, isso contém o número de bytes que foram copiados para pvData.

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 textual do erro.

Observações

Nota

O cabeçalho shlwapi.h define SHEnumValue 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)