ホーム › UI.Shell › GetDefaultUserProfileDirectoryW

GetDefaultUserProfileDirectoryW

関数

既定ユーザープロファイルのディレクトリを取得する(Unicode版)。

DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USERENV.dll  (Unicode / -W)
#include <windows.h>

BOOL GetDefaultUserProfileDirectoryW(
    LPWSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

パラメーター

名前	型	方向	説明
lpProfileDir	LPWSTR	outoptional	この関数が正常に終了したときに、既定ユーザーのプロファイルディレクトリへのパスを受け取るバッファーへのポインター。必要なバッファーサイズを取得するには、この値を NULL に設定します。
lpcchSize	DWORD*	inout	lpProfileDir バッファーのサイズを TCHAR 単位で指定します。 lpProfileDir で指定したバッファーが十分な大きさでない場合、または lpProfileDir が NULL の場合、この関数は失敗し、このパラメーターには終端の null 文字を含む必要なバッファーサイズが格納されます。

名前

型

方向

説明

lpProfileDir

LPWSTR

outoptional

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

lpcchSize

DWORD*

inout

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

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

戻り値の型: BOOL

公式ドキュメント

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

戻り値

型: BOOL

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

解説(Remarks)

次は、Windows XP において GetDefaultUserProfileDirectory が返すパスの例です。

C:\Documents and Settings\Default User

次は、Windows 7 において GetDefaultUserProfileDirectory が返すパスの例です。

C:\Users\Default

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

メモ

userenv.h ヘッダーは、GetDefaultUserProfileDirectory を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存ではないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// USERENV.dll  (Unicode / -W)
#include <windows.h>

BOOL GetDefaultUserProfileDirectoryW(
    LPWSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetDefaultUserProfileDirectoryW(
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProfileDir,   // LPWSTR optional, out
    ref uint lpcchSize   // DWORD* in/out
);

<DllImport("USERENV.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetDefaultUserProfileDirectoryW(
    <MarshalAs(UnmanagedType.LPWStr)> lpProfileDir As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef lpcchSize As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' lpProfileDir : LPWSTR optional, out
' lpcchSize : DWORD* in/out
Declare PtrSafe Function GetDefaultUserProfileDirectoryW Lib "userenv" ( _
    ByVal lpProfileDir As LongPtr, _
    ByRef lpcchSize As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetDefaultUserProfileDirectoryW = ctypes.windll.userenv.GetDefaultUserProfileDirectoryW
GetDefaultUserProfileDirectoryW.restype = wintypes.BOOL
GetDefaultUserProfileDirectoryW.argtypes = [
    wintypes.LPWSTR,  # lpProfileDir : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # lpcchSize : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
GetDefaultUserProfileDirectoryW = Fiddle::Function.new(
  lib['GetDefaultUserProfileDirectoryW'],
  [
    Fiddle::TYPE_VOIDP,  # lpProfileDir : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # lpcchSize : DWORD* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "userenv")]
extern "system" {
    fn GetDefaultUserProfileDirectoryW(
        lpProfileDir: *mut u16,  // LPWSTR optional, out
        lpcchSize: *mut u32  // DWORD* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true)]
public static extern bool GetDefaultUserProfileDirectoryW([MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProfileDir, ref uint lpcchSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetDefaultUserProfileDirectoryW' -Namespace Win32 -PassThru
# $api::GetDefaultUserProfileDirectoryW(lpProfileDir, lpcchSize)

#uselib "USERENV.dll"
#func global GetDefaultUserProfileDirectoryW "GetDefaultUserProfileDirectoryW" wptr, wptr
; GetDefaultUserProfileDirectoryW varptr(lpProfileDir), varptr(lpcchSize)   ; 戻り値は stat
; lpProfileDir : LPWSTR optional, out -> "wptr"
; lpcchSize : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "USERENV.dll"
#cfunc global GetDefaultUserProfileDirectoryW "GetDefaultUserProfileDirectoryW" var, var
; res = GetDefaultUserProfileDirectoryW(lpProfileDir, lpcchSize)
; lpProfileDir : LPWSTR optional, out -> "var"
; lpcchSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "USERENV.dll"
#cfunc global GetDefaultUserProfileDirectoryW "GetDefaultUserProfileDirectoryW" sptr, sptr
; res = GetDefaultUserProfileDirectoryW(varptr(lpProfileDir), varptr(lpcchSize))
; lpProfileDir : LPWSTR optional, out -> "sptr"
; lpcchSize : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。