SHRegGetPathA, fonction (shlwapi.h)

Article
11/20/2024

Récupère un chemin d’accès de fichier à partir du Registre, en développant les variables d’environnement en fonction des besoins.

Syntaxe

LSTATUS SHRegGetPathA(
  [in]  HKEY   hKey,
  [in]  LPCSTR pcszSubKey,
  [in]  LPCSTR pcszValue,
  [out] LPSTR  pszPath,
        DWORD  dwFlags
);

Paramètres

[in] hKey

Type : HKEY

Handle vers une clé actuellement ouverte ou une clé racine de Registre.

[in] pcszSubKey

Type : LPCTSTR

Pointeur vers une chaîne terminée par null qui contient le nom de la sous-clé.

[in] pcszValue

Type : LPCTSTR

Pointeur vers une chaîne terminée par null qui contient le nom de la valeur qui contient la chaîne de chemin d’accès non expirée.

[out] pszPath

Type : LPTSTR

Mémoire tampon pour contenir le chemin développé. Vous devez définir la taille de cette mémoire tampon sur MAX_PATH pour vous assurer qu’elle est suffisamment grande pour contenir la chaîne retournée.

dwFlags

Type : DWORD

Réservé.

Valeur de retour

Type : LSTATUS

Retourne ERROR_SUCCESS en cas de réussite, ou un code d’erreur Windows dans le cas contraire.

Remarques

Le type de données de la valeur de Registre spécifiée doit être REG_EXPAND_SZ ou REG_SZ. S’il a le type REG_EXPAND_SZ, toutes les variables d’environnement de la chaîne de Registre sont développées avec ExpandEnvironmentStrings. S’il a le type de données REG_SZ, les variables d’environnement ne seront pas développées et la chaîne pointée par pszPath sera identique à la chaîne dans le Registre.

Les chaînes d’environnement suivantes seront remplacées par leur chemin d’accès équivalent.

Chaîne d’environnement	Dossier
%USERPROFILE%	Dossier de profil de l’utilisateur actuel
%ALLUSERSPROFILE%	Dossier de profil Tous les utilisateurs
%ProgramFiles%	Dossier Program Files
%SystemRoot%	Dossier racine du système
%SystemDrive%	Lettre de lecteur système

remarque %USERPROFILE% est relative à l’utilisateur qui effectue l’appel. Cette fonction ne fonctionne pas si l’utilisateur est emprunt d’identité à partir d’un service.

Note

L’en-tête shlwapi.h définit SHRegGetPath comme 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. Le mélange 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.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows 2000 Professionnel, Windows XP [applications de bureau uniquement]
serveur minimum pris en charge	Windows 2000 Server [applications de bureau uniquement]
plateforme cible	Windows
d’en-tête	shlwapi.h
bibliothèque	Shlwapi.lib
DLL	Shlwapi.dll (version 5.0 ou ultérieure)

Partager via