GetDefaultUserProfileDirectory function

Retrieves the path to the root of the default user's profile.

Syntax

BOOL WINAPI GetDefaultUserProfileDirectory(
  _Out_opt_ LPTSTR  lpProfileDir,
  _Inout_   LPDWORD lpcchSize
);

Parameters

lpProfileDir [out, optional]

Type: LPTSTR

A pointer to a buffer that, when this function returns successfully, receives the path to the default user's profile directory. Set this value to NULL to determine the required size of the buffer.

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 GetDefaultUserProfileDirectory in Windows XP:

C:\Documents and Settings\Default User

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

C:\Users\Default

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

GetProfilesDirectory

GetUserProfileDirectory