ホーム › UI.Shell › LoadUserProfileA

LoadUserProfileA

関数

指定ユーザーのプロファイルを読み込む(ANSI版)。

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

シグネチャ

// USERENV.dll  (ANSI / -A)
#include <windows.h>

BOOL LoadUserProfileA(
    HANDLE hToken,
    PROFILEINFOA* lpProfileInfo
);

パラメーター

名前	型	方向	説明
hToken	HANDLE	in	ユーザーのトークン。LogonUser、CreateRestrictedToken、DuplicateToken、OpenProcessToken、または OpenThreadToken 関数から返されます。このトークンには TOKEN_QUERY、TOKEN_IMPERSONATE、TOKEN_DUPLICATE のアクセス権が必要です。詳細については、Access Rights for Access-Token Objects を参照してください。
lpProfileInfo	PROFILEINFOA*	inout	PROFILEINFO 構造体へのポインター。構造体の dwSize メンバーが `sizeof(PROFILEINFO)` に設定されていない場合、または lpUserName メンバーが NULL の場合、LoadUserProfile は失敗し ERROR_INVALID_PARAMETER を返します。詳細については「解説」を参照してください。

戻り値の型: BOOL

公式ドキュメント

指定したユーザーのプロファイルを読み込みます。プロファイルはローカルユーザープロファイルまたは移動ユーザープロファイルのいずれかです。(ANSI)

戻り値

型: BOOL

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

lpProfileInfo が指す構造体の dwSize メンバーが sizeof(PROFILEINFO) に設定されていない場合、または lpUserName メンバーが NULL の場合、この関数は失敗し ERROR_INVALID_PARAMETER を返します。

解説(Remarks)

ユーザーが対話的にログオンすると、システムはそのユーザーのプロファイルを自動的に読み込みます。サービスやアプリケーションがユーザーを偽装する場合、システムはそのユーザーのプロファイルを読み込みません。したがって、サービスまたはアプリケーションは LoadUserProfile を使用してユーザーのプロファイルを読み込む必要があります。

LoadUserProfile を呼び出すサービスやアプリケーションは、ユーザーが移動プロファイルを持っているかどうかを確認する必要があります。ユーザーが移動プロファイルを持っている場合は、そのパスを PROFILEINFO の lpProfilePath メンバーとして指定します。ユーザーの移動プロファイルのパスを取得するには、情報レベル 3 または 4 を指定して NetUserGetInfo 関数を呼び出します。

正常に復帰すると、PROFILEINFO の hProfile メンバーは、ユーザーのハイブのルートに対して開かれたレジストリキーハンドルになります。これはフルアクセス (KEY_ALL_ACCESS) で開かれます。ユーザーを偽装しているサービスがユーザーのレジストリファイルを読み書きする必要がある場合は、HKEY_CURRENT_USER の代わりにこのハンドルを使用してください。hProfile ハンドルを閉じないでください。代わりに、それを UnloadUserProfile 関数に渡します。この関数がハンドルを閉じます。ユーザーのレジストリハイブ内のキーに対するすべてのハンドルが閉じられていることを確認する必要があります。開いているレジストリハンドルをすべて閉じないと、ユーザーのプロファイルのアンロードに失敗します。詳細については、 Registry Key Security and Access Rights および Registry Hives を参照してください。

CreateProcessAsUser を呼び出す前に、LoadUserProfile 関数を使用してユーザーのレジストリハイブを HKEY_USERS レジストリキーに読み込むのは呼び出し側の責任であることに注意してください。これは、CreateProcessAsUser が指定したユーザーのプロファイルを HKEY_USERS に読み込まないためです。つまり、HKEY_CURRENT_USER レジストリキー内の情報へのアクセスが、通常の対話的ログオンと一致する結果を生成しない可能性があります。

呼び出し側のプロセスには SE_RESTORE_NAME および SE_BACKUP_NAME 特権が必要です。詳細については、Running with Special Privileges を参照してください。

Windows XP Service Pack 2 (SP2) および Windows Server 2003 以降では、呼び出し側は管理者または LocalSystem アカウントである必要があります。呼び出し側が単に管理者または LocalSystem アカウントを偽装するだけでは不十分です。

メモ

userenv.h ヘッダーは LoadUserProfile をエイリアスとして定義しており、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  (ANSI / -A)
#include <windows.h>

BOOL LoadUserProfileA(
    HANDLE hToken,
    PROFILEINFOA* lpProfileInfo
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool LoadUserProfileA(
    IntPtr hToken,   // HANDLE
    IntPtr lpProfileInfo   // PROFILEINFOA* in/out
);

<DllImport("USERENV.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function LoadUserProfileA(
    hToken As IntPtr,   ' HANDLE
    lpProfileInfo As IntPtr   ' PROFILEINFOA* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hToken : HANDLE
' lpProfileInfo : PROFILEINFOA* in/out
Declare PtrSafe Function LoadUserProfileA Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal lpProfileInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

LoadUserProfileA = ctypes.windll.userenv.LoadUserProfileA
LoadUserProfileA.restype = wintypes.BOOL
LoadUserProfileA.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE
    ctypes.c_void_p,  # lpProfileInfo : PROFILEINFOA* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
LoadUserProfileA = Fiddle::Function.new(
  lib['LoadUserProfileA'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE
    Fiddle::TYPE_VOIDP,  # lpProfileInfo : PROFILEINFOA* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "userenv")]
extern "system" {
    fn LoadUserProfileA(
        hToken: *mut core::ffi::c_void,  // HANDLE
        lpProfileInfo: *mut PROFILEINFOA  // PROFILEINFOA* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool LoadUserProfileA(IntPtr hToken, IntPtr lpProfileInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_LoadUserProfileA' -Namespace Win32 -PassThru
# $api::LoadUserProfileA(hToken, lpProfileInfo)

#uselib "USERENV.dll"
#func global LoadUserProfileA "LoadUserProfileA" sptr, sptr
; LoadUserProfileA hToken, varptr(lpProfileInfo)   ; 戻り値は stat
; hToken : HANDLE -> "sptr"
; lpProfileInfo : PROFILEINFOA* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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