Partager via

Fonction SHEnumValueA (shlwapi.h)

  • Article

Énumère les valeurs de la clé de Registre ouverte spécifiée.

Syntaxe

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

Paramètres

[in] hkey

Type : HKEY

Handle de la clé actuellement ouverte ou de l’une des valeurs prédéfinies suivantes.

HKEY_CLASSES_ROOT

HKEY_CURRENT_CONFIG

HKEY_CURRENT_USER

HKEY_LOCAL_MACHINE

HKEY_PERFORMANCE_DATA

HKEY_USERS

[in] dwIndex

Type : DWORD

Index de la valeur à récupérer. Ce paramètre doit être égal à zéro pour le premier appel et incrémenté pour les appels suivants.

pszValueName

Type : LPTSTR

Adresse d’une mémoire tampon de caractères qui reçoit le nom de la valeur énumérée. La taille de cette mémoire tampon est spécifiée dans pcchValueName.

[in, out, optional] pcchValueName

Type : LPDWORD

Adresse d’un DWORD qui, lors de l’entrée, contient la taille de la mémoire tampon à pszValueName, en caractères. À la sortie, contient le nombre de caractères qui ont été copiés dans pszValueName.

[out, optional] pdwType

Type : LPDWORD

Adresse d’un DWORD qui reçoit le type de données de la valeur. Il s’agit des mêmes valeurs que celles décrites sous le paramètre lpType de RegEnumValue.

pvData

Type : LPVOID

Adresse d’une mémoire tampon qui reçoit les données de l’entrée de valeur. La taille de cette mémoire tampon est spécifiée dans pcbData. Ce paramètre peut être NULL si les données ne sont pas requises.

[in, out, optional] pcbData

Type : LPDWORD

Adresse d’un DWORD qui, lors de l’entrée, contient la taille de la mémoire tampon au niveau pvData, en octets. À la sortie, il contient le nombre d’octets qui ont été copiés dans pvData.

Valeur retournée

Type : LSTATUS

Retourne ERROR_SUCCESS en cas de réussite, ou un code d’erreur différent de zéro défini dans Winerror.h dans le cas contraire. Vous pouvez utiliser la fonction FormatMessage avec l’indicateur FORMAT_MESSAGE_FROM_SYSTEM pour récupérer une description textuelle de l’erreur.

Remarques

Notes

L’en-tête shlwapi.h définit SHEnumValue en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. La combinaison de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge Windows 2000 Server [applications de bureau uniquement]
Plateforme cible Windows
En-tête shlwapi.h
Bibliothèque Shlwapi.lib
DLL Shlwapi.dll (version 4.71 ou ultérieure)