Função SHRegEnumUSValueA (shlwapi.h)

Enumera os valores da subchave do Registro especificada em uma subárvore específica do usuário (HKEY_CURRENT_USER ou HKEY_LOCAL_MACHINE).

Sintaxe

LSTATUS SHRegEnumUSValueA(
  [in]                HUSKEY          hUSkey,
  [in]                DWORD           dwIndex,
  [out]               LPSTR           pszValueName,
  [in, out]           LPDWORD         pcchValueName,
  [out, optional]     LPDWORD         pdwType,
  [out, optional]     void            *pvData,
  [in, out, optional] LPDWORD         pcbData,
  [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 KEY_SET_VALUE direito de acesso. Para obter mais informações, consulte de Direitos de Acesso e Segurança de Chave do Registro.

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

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

[out] pszValueName

Tipo: LPTSTR

Um ponteiro para um buffer de caracteres que recebe o nome do valor enumerado. O tamanho desse buffer é especificado em pcchValueNameLen.

[in, out] pcchValueName

Tipo: LPDWORD

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

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

[out, optional] pvData

Tipo: void*

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

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

[in] enumRegFlags

Tipo: SHREGENUM_FLAGS

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

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