PathCchStripToRoot-Funktion (pathcch.h)

  • Artikel

Entfernt alle Datei- und Verzeichniselemente in einem Pfad mit Ausnahme der Stamminformationen.

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

Hinweis Diese Funktion sollte anstelle von PathStripToRoot verwendet werden, um die Möglichkeit eines Pufferüberlaufs zu verhindern.

Syntax

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

Parameter

[in, out] pszPath

Ein Zeiger auf die Pfadzeichenfolge. Wenn diese Funktion erfolgreich zurückgibt, enthält diese Zeichenfolge nur die Stamminformationen aus diesem Pfad.

[in] cchPath

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

Rückgabewert

Diese Funktion gibt S_OK zurück, wenn der Pfad abgeschnitten wurde , S_FALSE , wenn der Pfad bereits nur ein Stamm oder ein HRESULT-Fehlercode war.

Hinweise

Einige Beispiele für die Wirkung dieser Funktion:

Anfängliche Zeichenfolge Endgültige Zeichenfolge
"C:\path1\path2\file" „C:\“
"\\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