Функция PathCompactPathExA (shlwapi.h)

Статья
11/20/2024

Усечение пути в пределах определенного количества символов путем замены компонентов пути многоточием.

Синтаксис

BOOL PathCompactPathExA(
  [out] LPSTR  pszOut,
  [in]  LPCSTR pszSrc,
  [in]  UINT   cchMax,
  [in]  DWORD  dwFlags
);

Параметры

[out] pszOut

Тип: LPTSTR

Адрес измененной строки.

[in] pszSrc

Тип: LPCTSTR

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

[in] cchMax

Тип: UINT

Максимальное число символов, содержащихся в новой строке, включая завершающийся пустой символ. Например, если cchMax = 8, результирующая строка может содержать не более 7 символов, а также завершающий символ NULL.

[in] dwFlags

Тип: DWORD

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

Тип: BOOL

Возвращает TRUE, если выполнено успешно или FALSE в противном случае.

Замечания

Разделитель '/' будет использоваться вместо '', если исходная строка использовала ее. Если pszSrc указывает на слишком длинное имя файла, а не путь, имя файла будет усечено до символов cchMax, включая многоточие и завершающийся символ null. Например, если входной файл имеет имя "My Filename" и cchMax равно 10, PathCompactPathEx вернет "My Fil...".

Заметка

Заголовок shlwapi.h определяет PathCompactPathEx как псевдоним, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОДа. Сочетание использования псевдонима, нейтрального для кодирования, с кодом, не зависящим от кодирования, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в соглашениях о прототипах функций.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Windows 2000 Профессиональный, Windows XP [только классические приложения]
минимальный поддерживаемый сервер	Windows 2000 Server [только классические приложения]
целевая платформа	Виндоус
заголовка	shlwapi.h
библиотеки	Shlwapi.lib
DLL	Shlwapi.dll (версия 4.71 или более поздняя)

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