PathUnExpandEnvStringsA, fonction (shlwapi.h)

Article
11/20/2024

Remplace certains noms de dossiers dans un chemin complet par leur chaîne d’environnement associée.

Syntaxe

BOOL PathUnExpandEnvStringsA(
  [in]  LPCSTR pszPath,
  [out] LPSTR  pszBuf,
  [in]  UINT   cchBuf
);

Paramètres

[in] pszPath

Type : LPCTSTR

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

[out] pszBuf

Type : LPTSTR

Pointeur vers une mémoire tampon qui, lorsque cette méthode retourne correctement, reçoit la chaîne non expirée. La taille de cette mémoire tampon doit être définie sur MAX_PATH pour s’assurer qu’elle est suffisamment grande pour contenir la chaîne retournée.

[in] cchBuf

Type : uiNT

Taille, en caractères, dans la mémoire tampon pszBuf.

Valeur de retour

Type : BOOL

Retourne TRUE en cas de réussite ; sinon, FALSE.

Remarques

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

Dossier	Chaîne d’environnement
Dossier de profil Tous les utilisateurs	%ALLUSERSPROFILE%
Dossier de données d’application de l’utilisateur actuel (Windows Vista et versions ultérieures uniquement).	%APPDATA%
Nom du système	%COMPUTERNAME%
Dossier Program Files	%ProgramFiles%
Dossier racine du système	%SystemRoot%
Lettre de lecteur système	%SystemDrive%
Dossier de profil de l’utilisateur actuel	%USERPROFILE%

Remarque %APPDATA% et %USERPROFILE% sont relatifs à l’utilisateur qui effectue l’appel. Cette fonction ne fonctionne pas si l’utilisateur est emprunt d’identité à partir d’un service. Pour plus d’informations sur les problèmes de contrôle d’accès, consultez contrôle d’accès.

Les variables d’environnement répertoriées dans le tableau ci-dessus peuvent ne pas toutes être définies sur tous les systèmes. Si une variable d’environnement n’est pas définie, elle n’est pas inexpliquée.

Note

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

Voir aussi

DoEnvironmentSubst

Partager via