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

Статья
11/20/2024

Заменяет определенные имена папок в полном пути связанной строкой среды.

Синтаксис

BOOL PathUnExpandEnvStringsA(
  [in]  LPCSTR pszPath,
  [out] LPSTR  pszBuf,
  [in]  UINT   cchBuf
);

Параметры

[in] pszPath

Тип: LPCTSTR

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

[out] pszBuf

Тип: LPTSTR

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

[in] cchBuf

Тип: UINT

Размер в символах в буфере pszBuf.

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

Тип: BOOL

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

Замечания

Следующие пути к папке заменяются эквивалентной строкой среды.

Папка	Строка среды
Папка профиля "Все пользователи"	%ALLUSERSPROFILE%
Папка данных приложения текущего пользователя (только Windows Vista и более поздних версий).	%APPDATA%
Имя системы	%COMPUTERNAME%
Папка Program Files	%ProgramFiles%
Корневая папка системы	%SystemRoot%
Буква системного диска	%SystemDrive%
Папка профиля текущего пользователя	%USERPROFILE%

примечание %APPDATA% и %USERPROFILE% относительно пользователя, выполняющего вызов. Эта функция не работает, если пользователь олицетворен из службы. Дополнительные сведения о проблемах управления доступом см. в управления доступом.

Переменные среды, перечисленные в приведенной выше таблице, могут не быть установлены во всех системах. Если переменная среды не задана, она не является необъяснимой.

Заметка

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

Требования

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

См. также

DoEnvironmentSubst

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