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

UnloadUserProfile

関数
読み込んだユーザープロファイルをアンロードする。
DLLUSERENV.dll呼出規約winapiSetLastErrorあり対応OSWindows 2000 以降

シグネチャ

// USERENV.dll
#include <windows.h>

BOOL UnloadUserProfile(
    HANDLE hToken,
    HANDLE hProfile
);

パラメーター

名前方向説明
hTokenHANDLEinユーザーのトークン。LogonUserCreateRestrictedTokenDuplicateTokenOpenProcessToken、または OpenThreadToken 関数から返されます。このトークンには TOKEN_IMPERSONATE および TOKEN_DUPLICATE アクセス権が必要です。詳細については、Access Rights for Access-Token Objects を参照してください。
hProfileHANDLEinレジストリキーへのハンドル。この値は PROFILEINFO 構造体の hProfile メンバーです。詳細については、LoadUserProfile の「解説」セクションおよび Registry Key Security and Access Rights を参照してください。

戻り値の型: BOOL

公式ドキュメント

LoadUserProfile 関数によって読み込まれたユーザーのプロファイルをアンロードします。呼び出し元はコンピューター上で管理者権限を持っている必要があります。詳細については、LoadUserProfile 関数の「解説」セクションを参照してください。

戻り値

型: BOOL

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

解説(Remarks)

UnloadUserProfile を呼び出す前に、ユーザーのレジストリハイブで開いたすべてのキーのハンドルが閉じられていることを確認する必要があります。開いているレジストリハンドルをすべて閉じないと、ユーザーのプロファイルのアンロードに失敗します。詳細については、 Registry Key Security and Access Rights および Registry Hives を参照してください。

管理者権限を必要とする関数の呼び出しの詳細については、Running with Special Privileges を参照してください。

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

各言語での呼び出し定義

// USERENV.dll
#include <windows.h>

BOOL UnloadUserProfile(
    HANDLE hToken,
    HANDLE hProfile
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", SetLastError = true, ExactSpelling = true)]
static extern bool UnloadUserProfile(
    IntPtr hToken,   // HANDLE
    IntPtr hProfile   // HANDLE
);
<DllImport("USERENV.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function UnloadUserProfile(
    hToken As IntPtr,   ' HANDLE
    hProfile As IntPtr   ' HANDLE
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' hToken : HANDLE
' hProfile : HANDLE
Declare PtrSafe Function UnloadUserProfile Lib "userenv" ( _
    ByVal hToken As LongPtr, _
    ByVal hProfile As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

UnloadUserProfile = ctypes.windll.userenv.UnloadUserProfile
UnloadUserProfile.restype = wintypes.BOOL
UnloadUserProfile.argtypes = [
    wintypes.HANDLE,  # hToken : HANDLE
    wintypes.HANDLE,  # hProfile : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('USERENV.dll')
UnloadUserProfile = Fiddle::Function.new(
  lib['UnloadUserProfile'],
  [
    Fiddle::TYPE_VOIDP,  # hToken : HANDLE
    Fiddle::TYPE_VOIDP,  # hProfile : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "userenv")]
extern "system" {
    fn UnloadUserProfile(
        hToken: *mut core::ffi::c_void,  // HANDLE
        hProfile: *mut core::ffi::c_void  // HANDLE
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("USERENV.dll", SetLastError = true)]
public static extern bool UnloadUserProfile(IntPtr hToken, IntPtr hProfile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'USERENV_UnloadUserProfile' -Namespace Win32 -PassThru
# $api::UnloadUserProfile(hToken, hProfile)
#uselib "USERENV.dll"
#func global UnloadUserProfile "UnloadUserProfile" sptr, sptr
; UnloadUserProfile hToken, hProfile   ; 戻り値は stat
; hToken : HANDLE -> "sptr"
; hProfile : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "USERENV.dll"
#cfunc global UnloadUserProfile "UnloadUserProfile" sptr, sptr
; res = UnloadUserProfile(hToken, hProfile)
; hToken : HANDLE -> "sptr"
; hProfile : HANDLE -> "sptr"
; BOOL UnloadUserProfile(HANDLE hToken, HANDLE hProfile)
#uselib "USERENV.dll"
#cfunc global UnloadUserProfile "UnloadUserProfile" intptr, intptr
; res = UnloadUserProfile(hToken, hProfile)
; hToken : HANDLE -> "intptr"
; hProfile : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	userenv = windows.NewLazySystemDLL("USERENV.dll")
	procUnloadUserProfile = userenv.NewProc("UnloadUserProfile")
)

// hToken (HANDLE), hProfile (HANDLE)
r1, _, err := procUnloadUserProfile.Call(
	uintptr(hToken),
	uintptr(hProfile),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function UnloadUserProfile(
  hToken: THandle;   // HANDLE
  hProfile: THandle   // HANDLE
): BOOL; stdcall;
  external 'USERENV.dll' name 'UnloadUserProfile';
result := DllCall("USERENV\UnloadUserProfile"
    , "Ptr", hToken   ; HANDLE
    , "Ptr", hProfile   ; HANDLE
    , "Int")   ; return: BOOL
●UnloadUserProfile(hToken, hProfile) = DLL("USERENV.dll", "bool UnloadUserProfile(void*, void*)")
# 呼び出し: UnloadUserProfile(hToken, hProfile)
# hToken : HANDLE -> "void*"
# hProfile : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "userenv" fn UnloadUserProfile(
    hToken: ?*anyopaque, // HANDLE
    hProfile: ?*anyopaque // HANDLE
) callconv(std.os.windows.WINAPI) i32;
proc UnloadUserProfile(
    hToken: pointer,  # HANDLE
    hProfile: pointer  # HANDLE
): int32 {.importc: "UnloadUserProfile", stdcall, dynlib: "USERENV.dll".}
pragma(lib, "userenv");
extern(Windows)
int UnloadUserProfile(
    void* hToken,   // HANDLE
    void* hProfile   // HANDLE
);
ccall((:UnloadUserProfile, "USERENV.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}),
      hToken, hProfile)
# hToken : HANDLE -> Ptr{Cvoid}
# hProfile : HANDLE -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t UnloadUserProfile(
    void* hToken,
    void* hProfile);
]]
local userenv = ffi.load("userenv")
-- userenv.UnloadUserProfile(hToken, hProfile)
-- hToken : HANDLE
-- hProfile : HANDLE
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('USERENV.dll');
const UnloadUserProfile = lib.func('__stdcall', 'UnloadUserProfile', 'int32_t', ['void *', 'void *']);
// UnloadUserProfile(hToken, hProfile)
// hToken : HANDLE -> 'void *'
// hProfile : HANDLE -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("USERENV.dll", {
  UnloadUserProfile: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.UnloadUserProfile(hToken, hProfile)
// hToken : HANDLE -> "pointer"
// hProfile : HANDLE -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t UnloadUserProfile(
    void* hToken,
    void* hProfile);
C, "USERENV.dll");
// $ffi->UnloadUserProfile(hToken, hProfile);
// hToken : HANDLE
// hProfile : HANDLE
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Userenv extends StdCallLibrary {
    Userenv INSTANCE = Native.load("userenv", Userenv.class);
    boolean UnloadUserProfile(
        Pointer hToken,   // HANDLE
        Pointer hProfile   // HANDLE
    );
}
@[Link("userenv")]
lib LibUSERENV
  fun UnloadUserProfile = UnloadUserProfile(
    hToken : Void*,   # HANDLE
    hProfile : Void*   # HANDLE
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef UnloadUserProfileNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef UnloadUserProfileDart = int Function(Pointer<Void>, Pointer<Void>);
final UnloadUserProfile = DynamicLibrary.open('USERENV.dll')
    .lookupFunction<UnloadUserProfileNative, UnloadUserProfileDart>('UnloadUserProfile');
// hToken : HANDLE -> Pointer<Void>
// hProfile : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function UnloadUserProfile(
  hToken: THandle;   // HANDLE
  hProfile: THandle   // HANDLE
): BOOL; stdcall;
  external 'USERENV.dll' name 'UnloadUserProfile';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "UnloadUserProfile"
  c_UnloadUserProfile :: Ptr () -> Ptr () -> IO CInt
-- hToken : HANDLE -> Ptr ()
-- hProfile : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let unloaduserprofile =
  foreign "UnloadUserProfile"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* hToken : HANDLE -> (ptr void) *)
(* hProfile : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library userenv (t "USERENV.dll"))
(cffi:use-foreign-library userenv)

(cffi:defcfun ("UnloadUserProfile" unload-user-profile :convention :stdcall) :int32
  (h-token :pointer)   ; HANDLE
  (h-profile :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $UnloadUserProfile = Win32::API::More->new('USERENV',
    'BOOL UnloadUserProfile(HANDLE hToken, HANDLE hProfile)');
# my $ret = $UnloadUserProfile->Call($hToken, $hProfile);
# hToken : HANDLE -> HANDLE
# hProfile : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目