Fonction SHGetValueA (shlwapi.h)

Article
08/26/2023

Récupère une valeur de Registre.

Syntaxe

LSTATUS SHGetValueA(
  [in]                HKEY   hkey,
  [in, optional]      LPCSTR pszSubKey,
  [in, optional]      LPCSTR pszValue,
  [out, optional]     DWORD  *pdwType,
  [out, optional]     void   *pvData,
  [in, out, optional] DWORD  *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, optional] pszSubKey

Type : LPCTSTR

Adresse d’une chaîne terminée par null qui spécifie le nom de la sous-clé à partir de laquelle la valeur doit être récupérée.

[in, optional] pszValue

Type : LPCTSTR

Adresse de la valeur.

[out, optional] pdwType

Type : LPDWORD

Type de valeur. Pour plus d’informations, consultez Types de données du Registre.

[out, optional] pvData

Type : LPVOID

Adresse de la mémoire tampon de données de destination.

[in, out, optional] pcbData

Type : LPDWORD

Taille de la mémoire tampon de données de destination.

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 générique de l’erreur.

Remarques

Si votre application doit définir/récupérer une série de valeurs dans la même clé, il est préférable d’ouvrir la clé une seule fois et de définir/récupérer les valeurs avec les fonctions de Registre Microsoft Win32 normales plutôt que d’utiliser cette fonction à plusieurs reprises.

Notes

L’en-tête shlwapi.h définit SHGetValue 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


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)

Partager via