Функция GetAllUsersProfileDirectoryA (userenv.h)
Извлекает путь к корню каталога, содержащего данные программы, совместно используемые всеми пользователями.
Синтаксис
USERENVAPI BOOL GetAllUsersProfileDirectoryA(
[out, optional] LPSTR lpProfileDir,
[in, out] LPDWORD lpcchSize
);
Параметры
[out, optional] lpProfileDir
Тип: LPTSTR
Указатель на буфер, который при успешном возврате этой функции получает путь. Присвойте этому значению значение NULL , чтобы определить требуемый размер буфера, включая завершающий символ NULL.
[in, out] lpcchSize
Тип: LPDWORD
Указатель на размер буфера lpProfileDir в TCHAR.
Если буфер, заданный параметром lpProfileDir , недостаточно велик или lpProfileDir имеет значение NULL, функция завершается ошибкой и этот параметр получает необходимый размер буфера, включая завершающий символ NULL.
Возвращаемое значение
Тип: BOOL
Значение TRUE в случае успешного выполнения; в противном случае — FALSE. Дополнительные сведения об ошибке можно получить, вызвав GetLastError.
Комментарии
Ниже приведен пример пути, возвращаемого командлетом GetAllUsersProfileDirectory в Windows XP:
C:\Documents and Settings\All Users
Ниже приведен пример пути, возвращаемого командлетом GetAllUsersProfileDirectory в Windows 7.
C:\ProgramData
Чтобы получить пути к подкаталогам этого каталога, используйте функцию SHGetFolderPath (Windows XP и более ранние версии) или SHGetKnownFolderPath (Windows Vista).
Примечание
Заголовок userenv.h определяет GetAllUsersProfileDirectory в качестве псевдонима, который автоматически выбирает версию ANSI или Юникод этой функции на основе определения константы препроцессора ЮНИКОД. Использование псевдонима, не зависящий от кодирования, с кодом, который не является нейтральным для кодировки, может привести к несоответствиям, которые приводят к ошибкам компиляции или времени выполнения. Дополнительные сведения см. в разделе Соглашения для прототипов функций.
Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 2000 Professional [только классические приложения] |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | userenv.h |
| Библиотека | Userenv.lib |
| DLL | Userenv.dll |