PathCchRemoveFileSpec-Funktion (pathcch.h)

Artikel
08/25/2023

Entfernt das letzte Element in einer Pfadzeichenfolge, unabhängig davon, ob es sich bei diesem Element um einen Dateinamen oder einen Verzeichnisnamen handelt. Der führende umgekehrte Schrägstrich des Elements wird ebenfalls entfernt.

Diese Funktion unterscheidet sich von PathRemoveFileSpec dadurch, dass sie Pfade mit den Präfixen "\", "\?" und "\?\UNC" akzeptiert.

HinweisDiese Funktion sollte anstelle von PathRemoveFileSpec verwendet werden, um die Möglichkeit eines Pufferüberlaufs zu verhindern.

Syntax

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

Parameter

[in, out] pszPath

Ein Zeiger auf die vollqualifizierte Pfadzeichenfolge. Wenn diese Funktion erfolgreich zurückgegeben wird, wurde für die Zeichenfolge das letzte Element und der führende umgekehrte Schrägstrich entfernt. Diese Funktion wirkt sich nicht auf Stammpfade wie "C:" aus. Bei einem Stammpfad wird die Pfadzeichenfolge unverändert zurückgegeben. Wenn eine Pfadzeichenfolge mit einem nachfolgenden umgekehrten Schrägstrich endet, wird nur dieser umgekehrte Schrägstrich entfernt.

[in] cchPath

Die Größe des Puffers, auf den pszPath in Zeichen verweist.

Rückgabewert

Diese Funktion gibt S_OK zurück, wenn die Funktion erfolgreich war, S_FALSE , wenn nichts zu entfernen war, oder andernfalls einen Fehlercode.

Hinweise

Die folgende Tabelle zeigt die Auswirkungen dieser Funktion auf eine Auswahl von Pfadzeichenfolgen.

Ursprüngliche Zeichenfolge	Zurückgegebene Zeichenfolge
"C:\path1"	„C:\“
"C:\path1\path2"	"C:\path1"
"C:\path1\"	"C:\path1"
"\\path1\path2\path3"	"\\path1\path2"
"\path1"	"\"

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 8 [Desktop-Apps \| UWP-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2012 [Desktop-Apps \| UWP-Apps]
Zielplattform	Windows
Kopfzeile	pathcch.h
Bibliothek	Pathcch.lib

Freigeben über