Função SHEnumKeyExA (shlwapi.h)

Artigo
11/20/2024

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 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 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. 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