SHRegSetPathA, fonction (shlwapi.h)

Prend un chemin d’accès de fichier, remplace les noms de dossiers par des chaînes d’environnement et place la chaîne résultante dans le Registre.

Syntaxe

LSTATUS SHRegSetPathA(
  [in] HKEY   hKey,
  [in] LPCSTR pcszSubKey,
  [in] LPCSTR pcszValue,
  [in] LPCSTR pcszPath,
       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 contenant le nom d’une sous-clé existante. Si la sous-clé n’existe pas, SHRegSetPath échoue.

[in] pcszValue

Type : LPCTSTR

Pointeur vers une chaîne terminée par null avec le nom de la valeur pour contenir la chaîne de chemin d’accès.

[in] pcszPath

Type : LPCTSTR

Pointeur vers une chaîne terminée par null avec un chemin d’accès de fichier complet.

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

Pour Windows 2000, SHRegSetPath utilise PathUnExpandEnvStrings pour convertir les noms de dossiers en chaîne d’environnement correspondante. Si des variables d’environnement ont été remplacées, la valeur de Registre est définie avec le type de données REG_EXPAND_SZ. Sinon, elle est définie avec le type de données REG_SZ.

Les chemins d’accès au dossier suivants seront remplacés par leur chaîne d’environnement équivalente.

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

 

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.

 

Les variables d’environnement répertoriées dans le tableau ci-dessus peuvent ne pas toutes être définies sur un système particulier. Si une variable d’environnement n’est pas définie, elle ne sera pas inexpliquée. En particulier, aucune de ces variables n’est définie pour l’environnement par défaut de Windows 95 ou Windows 98. La variable %ProgramFiles% est nouvelle pour Windows 2000 et ne sera généralement pas définie sur les systèmes Microsoft Windows NT 4.0.

Note

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