PathCchRemoveFileSpec, fonction (pathcch.h)

Article
03/04/2024

Supprime le dernier élément d’une chaîne de chemin d’accès, qu’il s’agisse d’un nom de fichier ou d’un nom de répertoire. La barre oblique inverse de début de l’élément est également supprimée.

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

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

Syntaxe

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

Paramètres

[in, out] pszPath

Pointeur vers la chaîne de chemin d’accès complet. Lorsque cette fonction retourne correctement, son dernier élément et sa barre oblique inverse de début ont été supprimés pour la chaîne. Cette fonction n’affecte pas les chemins d’accès racine tels que « C : ». Dans le cas d’un chemin d’accès racine, la chaîne de chemin d’accès est retournée sans que cela soit affecté. Si une chaîne de chemin se termine par une barre oblique inverse de fin, seule cette barre oblique inverse est supprimée.

[in] cchPath

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

Valeur retournée

Cette fonction retourne S_OK si la fonction a réussi, S_FALSE s’il n’y avait rien à supprimer ou un code d’erreur dans le cas contraire.

Remarques

Le tableau suivant montre l’effet de cette fonction sur une sélection de chaînes de chemin d’accès.

Chaîne d’origine	Chaîne retournée
« C :\path1 »	« C:\ »
« C :\path1\path2 »	« C :\path1 »
« C :\path1\ »	« C :\path1 »
« \\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