Поделиться через


Функция PathCchStripToRoot (pathcch.h)

Удаляет все элементы файла и каталога в пути, за исключением корневой информации.

Эта функция отличается от PathStripToRoot тем, что она принимает пути с префиксами "\", "\?" и "\?\UNC".

Примечание Эту функцию следует использовать вместо PathStripToRoot , чтобы предотвратить переполнение буфера.

Синтаксис

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

Параметры

[in, out] pszPath

Указатель на строку пути. При успешном выполнении этой функции эта строка содержит только корневую информацию, полученную из этого пути.

[in] cchPath

Размер буфера, на который указывает pszPath, в символах.

Возвращаемое значение

Эта функция возвращает S_OK , если путь был усечен, S_FALSE , если путь уже был только корнем, или код сбоя HRESULT .

Комментарии

Некоторые примеры эффекта этой функции:

Начальная строка Последняя строка
"C:\path1\path2\file" "C:\"
"\\path1\path2\path3" "\\path1\path2"
"\path1" "\"

Требования

Требование Значение
Минимальная версия клиента Windows 8 [классические приложения | Приложения UWP]
Минимальная версия сервера Windows Server 2012 [классические приложения | Приложения UWP]
Целевая платформа Windows
Header pathcch.h
Библиотека Pathcch.lib