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

LoadUserProfileW

関数
指定ユーザーのプロファイルを読み込む(Unicode版)。
DLLUSERENV.dll文字セットUnicode (-W)呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

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

BOOL LoadUserProfileW(
    HANDLE hToken,
    PROFILEINFOW* lpProfileInfo
);

パラメーター

名前方向
hTokenHANDLEin
lpProfileInfoPROFILEINFOW*inout

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL LoadUserProfileW(
    HANDLE hToken,
    PROFILEINFOW* lpProfileInfo
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Unicode, SetLastError = true, ExactSpelling = true)]
static extern bool LoadUserProfileW(
    IntPtr hToken,   // HANDLE
    IntPtr lpProfileInfo   // PROFILEINFOW* in/out
);
<DllImport("USERENV.dll", CharSet:=CharSet.Unicode, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadUserProfileW(
    hToken As IntPtr,   ' HANDLE
    lpProfileInfo As IntPtr   ' PROFILEINFOW* in/out
) As Boolean
End Function
' hToken : HANDLE
' lpProfileInfo : PROFILEINFOW* in/out
Declare PtrSafe Function LoadUserProfileW Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpProfileInfo As LongPtr) 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

LoadUserProfileW = ctypes.windll.userenv.LoadUserProfileW
LoadUserProfileW.restype = wintypes.BOOL
LoadUserProfileW.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE
    ctypes.c_void_p,  # lpProfileInfo : PROFILEINFOW* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
LoadUserProfileW = Fiddle::Function.new(
  lib['LoadUserProfileW'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE
    Fiddle::TYPE_VOIDP,  # lpProfileInfo : PROFILEINFOW* in/out
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "userenv")]
extern "system" {
    fn LoadUserProfileW(
        hToken: *mut core::ffi::c_void,  // HANDLE
        lpProfileInfo: *mut PROFILEINFOW  // PROFILEINFOW* 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 LoadUserProfileW(IntPtr hToken, IntPtr lpProfileInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_LoadUserProfileW' -Namespace Win32 -PassThru
# $api::LoadUserProfileW(hToken, lpProfileInfo)
#uselib "USERENV.dll"
#func global LoadUserProfileW "LoadUserProfileW" wptr, wptr
; LoadUserProfileW hToken, varptr(lpProfileInfo)   ; 戻り値は stat
; hToken : HANDLE -> "wptr"
; lpProfileInfo : PROFILEINFOW* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "USERENV.dll"
#cfunc global LoadUserProfileW "LoadUserProfileW" sptr, var
; res = LoadUserProfileW(hToken, lpProfileInfo)
; hToken : HANDLE -> "sptr"
; lpProfileInfo : PROFILEINFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL LoadUserProfileW(HANDLE hToken, PROFILEINFOW* lpProfileInfo)
#uselib "USERENV.dll"
#cfunc global LoadUserProfileW "LoadUserProfileW" intptr, var
; res = LoadUserProfileW(hToken, lpProfileInfo)
; hToken : HANDLE -> "intptr"
; lpProfileInfo : PROFILEINFOW* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procLoadUserProfileW = userenv.NewProc("LoadUserProfileW")
)

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