Função SHRegEnumUSKeyA (shlwapi.h)

Enumera as subchaves de uma subchave do Registro em uma subárvore específica do usuário (HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE).

Sintaxe

LSTATUS SHRegEnumUSKeyA(
  [in]      HUSKEY          hUSKey,
  [in]      DWORD           dwIndex,
  [out]     LPSTR           pszName,
  [in, out] LPDWORD         pcchName,
  [in]      SHREGENUM_FLAGS enumRegFlags
);

Parâmetros

[in] hUSKey

Tipo: HUSKEY

Um identificador para uma subchave do Registro aberta no momento. A subchave deve ter sido aberta com o direito de acesso KEY_SET_VALUE. Para obter mais informações, consulte Segurança de chave do Registro e Direitos de Acesso.

Esse identificador pode ser obtido por meio da função SHRegOpenUSKey .

[in] 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.

[out] pszName

Tipo: LPTSTR

Um ponteiro para um buffer de caracteres que recebe o nome da chave enumerada.

[in, out] pcchName

Tipo: LPDWORD

Um ponteiro para 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.

[in] enumRegFlags

Tipo: SHREGENUM_FLAGS

Um SHREGENUM_FLAGS que especifica a chave base na qual a enumeração deve ocorrer.

Retornar valor

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 SHRegEnumUSKey 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)