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

Статья
08/26/2023

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

Синтаксис

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 или Юникод этой функции на основе определения константы препроцессора UNICODE. Сочетание использования псевдонима, не зависящий от кодировки, с кодом, не зависящим от кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или среды выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.

Требования


Минимальная версия клиента	Windows 2000 Professional, Windows XP [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	shlwapi.h
Библиотека	Shlwapi.lib
DLL	Shlwapi.dll (версия 5.0 или более поздняя)

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

DoEnvironmentSubst