Функция GetUserProfileDirectoryW (userenv.h)

Статья
11/20/2024

Извлекает путь к корневому каталогу указанного профиля пользователя.

Синтаксис

USERENVAPI BOOL GetUserProfileDirectoryW(
  [in]            HANDLE  hToken,
  [out, optional] LPWSTR  lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

Параметры

[in] hToken

Тип: HANDLE

Маркер для пользователя, который возвращается LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessTokenили функции OpenThreadToken. Маркер должен иметь TOKEN_QUERY доступ. Дополнительные сведения см. в разделе Access Rights for Access-Token Objects.

[out, optional] lpProfileDir

Тип: LPTSTR

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

[in, out] lpcchSize

Тип: LPDWORD

Задает размер буфера lpProfileDir в TCHARs.

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

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

Тип: BOOL

TRUE в случае успешного выполнения; в противном случае FALSE. Чтобы получить расширенные сведения об ошибке, вызовите GetLastError.

Замечания

Ниже приведен пример пути, возвращаемого GetUserProfileDirectory в Windows XP:

C:\Documents and Settings\Joe

Ниже приведен пример пути, возвращаемого GetUserProfileDirectory в Windows 7.

C:\Users\Joe

Чтобы получить пути к подкаталогам этого каталога, используйте функцию SHGetFolderPath (Windows XP и более ранних версий) или SHGetKnownFolderPath (Windows Vista).

Заметка

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

Требования

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

См. также

GetAllUsersProfileDirectory

GetDefaultUserProfileDirectory

GetProfilesDirectory

Обзор профилей пользователей

Справочник по профилям пользователей

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