PathCchStripToRoot, fonction (pathcch.h)

Article
03/04/2024

Supprime tous les éléments de fichier et de répertoire d’un chemin d’accès à l’exception des informations racine.

Cette fonction diffère de PathStripToRoot en ce qu’elle accepte les chemins avec les préfixes « \ », « \ ? » et « \ ?\UNC ».

Note Cette fonction doit être utilisée à la place de PathStripToRoot pour éviter la possibilité d’un dépassement de mémoire tampon.

Syntaxe

WINPATHCCHAPI HRESULT PathCchStripToRoot(
  [in, out] PWSTR  pszPath,
  [in]      size_t cchPath
);

Paramètres

[in, out] pszPath

Pointeur vers la chaîne de chemin d’accès. Lorsque cette fonction retourne correctement, cette chaîne contient uniquement les informations racine extraites de ce chemin.

[in] cchPath

Taille de la mémoire tampon pointée vers pszPath, en caractères.

Valeur retournée

Cette fonction retourne S_OK si le chemin a été tronqué, S_FALSE si le chemin n’était déjà qu’une racine ou un code d’échec HRESULT .

Remarques

Voici quelques exemples de l’effet de cette fonction :

Chaîne initiale	Chaîne finale
« C :\path1\path2\file »	« C:\ »
« \\path1\path2\path3 »	« \\path1\path2 »
« \path1 »	"\"

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 8 [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows Server 2012 [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	pathcch.h
Bibliothèque	Pathcch.lib

Partager via