GetUserProfileDirectory function

Retrieves the path to the root directory of the specified user's profile.

Syntax

BOOL WINAPI GetUserProfileDirectory(
  _In_      HANDLE  hToken,
  _Out_opt_ LPTSTR  lpProfileDir,
  _Inout_   LPDWORD lpcchSize
);

Parameters

hToken [in]

Type: HANDLE

A token for the user, which is returned by the LogonUser, CreateRestrictedToken, DuplicateToken, OpenProcessToken, or OpenThreadToken function. The token must have TOKEN_QUERY access. For more information, see Access Rights for Access-Token Objects.

lpProfileDir [out, optional]

Type: LPTSTR

A pointer to a buffer that, when this function returns successfully, receives the path to the specified user's profile directory.

lpcchSize [in, out]

Type: LPDWORD

Specifies the size of the lpProfileDir buffer, in TCHARs.

If the buffer specified by lpProfileDir is not large enough or lpProfileDir is NULL, the function fails and this parameter receives the necessary buffer size, including the terminating null character.

Return value

Type: BOOL

TRUE if successful; otherwise, FALSE. To get extended error information, call GetLastError.

Remarks

The following is an example of the path returned by GetUserProfileDirectory in Windows XP:

C:\Documents and Settings\Joe

The following is an example of the path returned by GetUserProfileDirectory in Windows 7:

C:\Users\Joe

To obtain the paths of subdirectories of this directory, use the SHGetFolderPath (Windows XP and earlier) or SHGetKnownFolderPath (Windows Vista) function.

Requirements

See also

User Profiles Overview

User Profiles Reference

GetAllUsersProfileDirectory

GetDefaultUserProfileDirectory

GetProfilesDirectory