GetDefaultUserProfileDirectoryW 関数 (userenv.h)

既定のユーザーのプロファイルのルートへのパスを取得します。

構文

USERENVAPI BOOL GetDefaultUserProfileDirectoryW(
  [out, optional] LPWSTR  lpProfileDir,
  [in, out]       LPDWORD lpcchSize
);

パラメーター

[out, optional] lpProfileDir

種類: LPTSTR

この関数が正常に返されると、既定のユーザーのプロファイル ディレクトリへのパスを受け取るバッファーへのポインター。 バッファーの必要なサイズを決定するには、この値を NULL に設定します。

[in, out] lpcchSize

型: LPDWORD

TCHAR の lpProfileDir バッファーのサイズを指定します。

lpProfileDir で指定されたバッファーの大きさが十分でない場合、または lpProfileDir が NULL の場合、関数は失敗し、このパラメーターは必要なバッファー サイズ (終端の null 文字を含む) を受け取ります。

戻り値

種類: BOOL

成功した場合は TRUE。それ以外の場合は FALSE。 詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

Windows XP の GetDefaultUserProfileDirectory によって返されるパスの例を次に示します。

C:\Documents and Settings\Default User

Windows 7 の GetDefaultUserProfileDirectory によって返されるパスの例を次に示します。

C:\Users\Default

このディレクトリのサブディレクトリのパスを取得するには、 SHGetFolderPath (Windows XP 以前) または SHGetKnownFolderPath (Windows Vista) 関数を使用します。

注意

userenv.h ヘッダーは、Unicode プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして GetDefaultUserProfileDirectory を定義します。 encoding-neutral エイリアスの使用を encoding-neutral ではないコードと混在すると、コンパイル エラーまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件	値
サポートされている最小のクライアント	Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	userenv.h
Library	Userenv.lib
[DLL]	Userenv.dll

こちらもご覧ください

GetAllUsersProfileDirectory

GetProfilesDirectory

GetUserProfileDirectory

ユーザー プロファイルの概要

ユーザー プロファイル リファレンス