PathUnExpandEnvStringsA, fonction (shlwapi.h)

Article
08/26/2023

Remplace certains noms de dossiers dans un chemin d’accès complet par la 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 d’une longueur maximale MAX_PATH qui contient le chemin d’accès à inexpliqué.

[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 garantir 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 retournée

Type : BOOL

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

Remarques

Les chemins d’accès aux dossiers 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%

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

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 aucune variable d’environnement n’est définie, elle n’est pas inexpliquée.

Notes

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

Voir aussi

DoEnvironmentSubst

Partager via