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

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

Синтаксис

USERENVAPI BOOL GetUserProfileDirectoryA(
  [in]            HANDLE  hToken,
  [out, optional] LPSTR   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.

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

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

Тип: BOOL

Если функция выполнена успешно, возвращаемое значение ненулевое.

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

Замечания

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

C:\Documents and Settings\Joe

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

C:\Users\Joe

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

Требования

См. также

GetAllUsersProfileDirectory

GetDefaultUserProfileDirectory

GetProfilesDirectory

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

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