Share via


Função SHEnumKeyExA (shlwapi.h)

Enumera as subchaves da chave do Registro aberta especificada.

Sintaxe

LSTATUS SHEnumKeyExA(
  [in] HKEY    hkey,
       DWORD   dwIndex,
       LPSTR   pszName,
  [in] LPDWORD pcchName
);

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

dwIndex

Tipo: DWORD

O índice da subchave a ser recuperada. Esse parâmetro deve ser zero para a primeira chamada e incrementado para chamadas subsequentes.

pszName

Tipo: LPTSTR

O endereço de um buffer de caracteres que recebe o nome da chave enumerada.

[in] pcchName

Tipo: LPDWORD

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

Valor retornado

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.

Comentários

Observação

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

   
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)