Win32 API 日本語リファレンス
ホームUI.Shell › GetUserProfileDirectoryW

GetUserProfileDirectoryW

関数
トークンが示すユーザーのプロファイルディレクトリを取得する(Unicode版)。
DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL GetUserProfileDirectoryW(
    HANDLE hToken,
    LPWSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);

パラメーター

名前方向
hTokenHANDLEin
lpProfileDirLPWSTRoutoptional
lpcchSizeDWORD*inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL GetUserProfileDirectoryW(
    HANDLE hToken,
    LPWSTR lpProfileDir,   // optional
    DWORD* lpcchSize
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool GetUserProfileDirectoryW(
    IntPtr hToken,   // HANDLE
    [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 GetUserProfileDirectoryW(
    hToken As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> lpProfileDir As System.Text.StringBuilder,   ' LPWSTR optional, out
    ByRef lpcchSize As UInteger   ' DWORD* in/out
) As Boolean
End Function
' hToken : HANDLE
' lpProfileDir : LPWSTR optional, out
' lpcchSize : DWORD* in/out
Declare PtrSafe Function GetUserProfileDirectoryW Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    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

GetUserProfileDirectoryW = ctypes.windll.userenv.GetUserProfileDirectoryW
GetUserProfileDirectoryW.restype = wintypes.BOOL
GetUserProfileDirectoryW.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE
    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')
GetUserProfileDirectoryW = Fiddle::Function.new(
  lib['GetUserProfileDirectoryW'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE
    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 GetUserProfileDirectoryW(
        hToken: *mut core::ffi::c_void,  // HANDLE
        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 GetUserProfileDirectoryW(IntPtr hToken, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProfileDir, ref uint lpcchSize);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_GetUserProfileDirectoryW' -Namespace Win32 -PassThru
# $api::GetUserProfileDirectoryW(hToken, lpProfileDir, lpcchSize)
#uselib "USERENV.dll"
#func global GetUserProfileDirectoryW "GetUserProfileDirectoryW" wptr, wptr, wptr
; GetUserProfileDirectoryW hToken, varptr(lpProfileDir), varptr(lpcchSize)   ; 戻り値は stat
; hToken : HANDLE -> "wptr"
; lpProfileDir : LPWSTR optional, out -> "wptr"
; lpcchSize : DWORD* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USERENV.dll"
#cfunc global GetUserProfileDirectoryW "GetUserProfileDirectoryW" sptr, var, var
; res = GetUserProfileDirectoryW(hToken, lpProfileDir, lpcchSize)
; hToken : HANDLE -> "sptr"
; lpProfileDir : LPWSTR optional, out -> "var"
; lpcchSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetUserProfileDirectoryW(HANDLE hToken, LPWSTR lpProfileDir, DWORD* lpcchSize)
#uselib "USERENV.dll"
#cfunc global GetUserProfileDirectoryW "GetUserProfileDirectoryW" intptr, var, var
; res = GetUserProfileDirectoryW(hToken, lpProfileDir, lpcchSize)
; hToken : HANDLE -> "intptr"
; lpProfileDir : LPWSTR optional, out -> "var"
; lpcchSize : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procGetUserProfileDirectoryW = userenv.NewProc("GetUserProfileDirectoryW")
)

// hToken (HANDLE), lpProfileDir (LPWSTR optional, out), lpcchSize (DWORD* in/out)
r1, _, err := procGetUserProfileDirectoryW.Call(
	uintptr(hToken),
	uintptr(lpProfileDir),
	uintptr(lpcchSize),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetUserProfileDirectoryW(
  hToken: THandle;   // HANDLE
  lpProfileDir: PWideChar;   // LPWSTR optional, out
  lpcchSize: Pointer   // DWORD* in/out
): BOOL; stdcall;
  external 'USERENV.dll' name 'GetUserProfileDirectoryW';
result := DllCall("USERENV\GetUserProfileDirectoryW"
    , "Ptr", hToken   ; HANDLE
    , "Ptr", lpProfileDir   ; LPWSTR optional, out
    , "Ptr", lpcchSize   ; DWORD* in/out
    , "Int")   ; return: BOOL
●GetUserProfileDirectoryW(hToken, lpProfileDir, lpcchSize) = DLL("USERENV.dll", "bool GetUserProfileDirectoryW(void*, char*, void*)")
# 呼び出し: GetUserProfileDirectoryW(hToken, lpProfileDir, lpcchSize)
# hToken : HANDLE -> "void*"
# lpProfileDir : LPWSTR optional, out -> "char*"
# lpcchSize : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。