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

Статья
08/25/2023

Добавляет обратную косую черту в конец строки, чтобы создать правильный синтаксис для пути. Если исходный путь уже имеет обратную косую черту в конце, обратная косая черта не будет добавлена.

Эта функция отличается от PathCchAddBackslash тем, что она может возвращать указатель на новый конец строки и сообщать о количестве неиспользуемых символов, оставшихся в буфере.

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

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

Синтаксис

WINPATHCCHAPI HRESULT PathCchAddBackslashEx(
  [in, out]       PWSTR  pszPath,
  [in]            size_t cchPath,
  [out, optional] PWSTR  *ppszEnd,
  [out, optional] size_t *pcchRemaining
);

Параметры

[in, out] pszPath

Указатель на строку пути. Если эта функция возвращается успешно, буфер содержит строку с добавленной обратной косой чертой. Это значение не должно иметь значение NULL.

[in] cchPath

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

[out, optional] ppszEnd

Значение, которое при успешном возвращении этой функции получает адрес указателя на завершающий символ NULL в конце строки.

[out, optional] pcchRemaining

Указатель на значение, которое при успешном возвращении этой функции задается на количество неиспользуемых символов в буфере назначения, включая завершающий символ NULL.

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

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

Требования

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

См. также раздел

PathCchAddBackslash

Share via