Win32 API 日本語リファレンス
ホームSystem.Threading › QueueUserAPC2

QueueUserAPC2

関数
フラグ指定付きでスレッドにユーザーAPCを登録する。
DLLKERNEL32.dll呼出規約winapi

シグネチャ

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

BOOL QueueUserAPC2(
    PAPCFUNC ApcRoutine,
    HANDLE Thread,
    UINT_PTR Data,
    QUEUE_USER_APC_FLAGS Flags
);

パラメーター

名前方向説明
ApcRoutinePAPCFUNCin

指定したスレッドがアラート可能な待機操作を実行したときに呼び出される、アプリケーションが提供する APC 関数へのポインターです。詳細については、APCProc を参照してください。

特殊ユーザーモード APC の場合、アラート可能な待機は必要ありません。特殊ユーザーモード APC の詳細については、備考を参照してください。

ThreadHANDLEinスレッドへのハンドルです。このハンドルには THREAD_SET_CONTEXT アクセス権限が必要です。詳細については、同期オブジェクトのセキュリティとアクセス権 を参照してください。
DataUINT_PTRinApcRoutine パラメーターが指す APC 関数に渡される単一の値です。
FlagsQUEUE_USER_APC_FLAGSinユーザーモード APC の動作を変更する、QUEUE_USER_APC_FLAGS 列挙型 の値です。

戻り値の型: BOOL

公式ドキュメント

指定したスレッドの APC キューに、ユーザーモードの非同期プロシージャ呼び出し (APC) オブジェクトを追加します。(QueueUserAPC2)

戻り値

関数が成功した場合、戻り値は 0 以外になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

通常のユーザーモード APC は、対象スレッドがアラート可能な状態にある場合にのみ実行されます。通常のユーザーモード APC に関する追加の備考については、QueueUserAPC 関数を参照してください。

特殊ユーザーモード APC は、対象スレッドがアラート可能な状態にない場合でも常に実行されます。たとえば、対象スレッドが現在ユーザーモードのコードを実行している場合や、アラート可能な待機を実行している場合、対象スレッドは APC 実行のために即座に中断されます。対象スレッドがシステムコールを実行中の場合や、アラート不可能な待機を実行中の場合は、システムコールまたはアラート不可能な待機が完了した後に APC が実行されます (待機は中断されません)。

特殊ユーザーモード APC の実行は対象スレッドと同期されないため、(マルチスレッドと同期に関する通常の要件に加えて) 特別な注意が必要です。たとえば、ロックを取得する際、中断された対象スレッドが既にそのロックを所有していたり、ロックの取得または解放の途中であったりする場合があります。さらに、特殊ユーザーモード APC の受信をスレッドがブロックする手段は存在しないため、既に特殊ユーザーモード APC を実行しているスレッドに対して、別の特殊ユーザーモード APC が実行される可能性があります。

現在、特殊ユーザーモード APC はネイティブアーキテクチャでのみサポートされており、WoW 上での実行ではサポートされていません。

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

各言語での呼び出し定義

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

BOOL QueueUserAPC2(
    PAPCFUNC ApcRoutine,
    HANDLE Thread,
    UINT_PTR Data,
    QUEUE_USER_APC_FLAGS Flags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", ExactSpelling = true)]
static extern bool QueueUserAPC2(
    IntPtr ApcRoutine,   // PAPCFUNC
    IntPtr Thread,   // HANDLE
    UIntPtr Data,   // UINT_PTR
    int Flags   // QUEUE_USER_APC_FLAGS
);
<DllImport("KERNEL32.dll", ExactSpelling:=True)>
Public Shared Function QueueUserAPC2(
    ApcRoutine As IntPtr,   ' PAPCFUNC
    Thread As IntPtr,   ' HANDLE
    Data As UIntPtr,   ' UINT_PTR
    Flags As Integer   ' QUEUE_USER_APC_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' ApcRoutine : PAPCFUNC
' Thread : HANDLE
' Data : UINT_PTR
' Flags : QUEUE_USER_APC_FLAGS
Declare PtrSafe Function QueueUserAPC2 Lib "kernel32" ( _
    ByVal ApcRoutine As LongPtr, _
    ByVal Thread As LongPtr, _
    ByVal Data As LongPtr, _
    ByVal Flags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

QueueUserAPC2 = ctypes.windll.kernel32.QueueUserAPC2
QueueUserAPC2.restype = wintypes.BOOL
QueueUserAPC2.argtypes = [
    ctypes.c_void_p,  # ApcRoutine : PAPCFUNC
    wintypes.HANDLE,  # Thread : HANDLE
    ctypes.c_size_t,  # Data : UINT_PTR
    ctypes.c_int,  # Flags : QUEUE_USER_APC_FLAGS
]
require 'fiddle'
require 'fiddle/import'

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procQueueUserAPC2 = kernel32.NewProc("QueueUserAPC2")
)

// ApcRoutine (PAPCFUNC), Thread (HANDLE), Data (UINT_PTR), Flags (QUEUE_USER_APC_FLAGS)
r1, _, err := procQueueUserAPC2.Call(
	uintptr(ApcRoutine),
	uintptr(Thread),
	uintptr(Data),
	uintptr(Flags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function QueueUserAPC2(
  ApcRoutine: Pointer;   // PAPCFUNC
  Thread: THandle;   // HANDLE
  Data: NativeUInt;   // UINT_PTR
  Flags: Integer   // QUEUE_USER_APC_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'QueueUserAPC2';
result := DllCall("KERNEL32\QueueUserAPC2"
    , "Ptr", ApcRoutine   ; PAPCFUNC
    , "Ptr", Thread   ; HANDLE
    , "UPtr", Data   ; UINT_PTR
    , "Int", Flags   ; QUEUE_USER_APC_FLAGS
    , "Int")   ; return: BOOL
●QueueUserAPC2(ApcRoutine, Thread, Data, Flags) = DLL("KERNEL32.dll", "bool QueueUserAPC2(void*, void*, int, int)")
# 呼び出し: QueueUserAPC2(ApcRoutine, Thread, Data, Flags)
# ApcRoutine : PAPCFUNC -> "void*"
# Thread : HANDLE -> "void*"
# Data : UINT_PTR -> "int"
# Flags : QUEUE_USER_APC_FLAGS -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn QueueUserAPC2(
    ApcRoutine: ?*anyopaque, // PAPCFUNC
    Thread: ?*anyopaque, // HANDLE
    Data: usize, // UINT_PTR
    Flags: i32 // QUEUE_USER_APC_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc QueueUserAPC2(
    ApcRoutine: pointer,  # PAPCFUNC
    Thread: pointer,  # HANDLE
    Data: uint,  # UINT_PTR
    Flags: int32  # QUEUE_USER_APC_FLAGS
): int32 {.importc: "QueueUserAPC2", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int QueueUserAPC2(
    void* ApcRoutine,   // PAPCFUNC
    void* Thread,   // HANDLE
    size_t Data,   // UINT_PTR
    int Flags   // QUEUE_USER_APC_FLAGS
);
ccall((:QueueUserAPC2, "KERNEL32.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{Cvoid}, Csize_t, Int32),
      ApcRoutine, Thread, Data, Flags)
# ApcRoutine : PAPCFUNC -> Ptr{Cvoid}
# Thread : HANDLE -> Ptr{Cvoid}
# Data : UINT_PTR -> Csize_t
# Flags : QUEUE_USER_APC_FLAGS -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t QueueUserAPC2(
    void* ApcRoutine,
    void* Thread,
    uintptr_t Data,
    int32_t Flags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.QueueUserAPC2(ApcRoutine, Thread, Data, Flags)
-- ApcRoutine : PAPCFUNC
-- Thread : HANDLE
-- Data : UINT_PTR
-- Flags : QUEUE_USER_APC_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const QueueUserAPC2 = lib.func('__stdcall', 'QueueUserAPC2', 'int32_t', ['void *', 'void *', 'uintptr_t', 'int32_t']);
// QueueUserAPC2(ApcRoutine, Thread, Data, Flags)
// ApcRoutine : PAPCFUNC -> 'void *'
// Thread : HANDLE -> 'void *'
// Data : UINT_PTR -> 'uintptr_t'
// Flags : QUEUE_USER_APC_FLAGS -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("KERNEL32.dll", {
  QueueUserAPC2: { parameters: ["pointer", "pointer", "usize", "i32"], result: "i32" },
});
// lib.symbols.QueueUserAPC2(ApcRoutine, Thread, Data, Flags)
// ApcRoutine : PAPCFUNC -> "pointer"
// Thread : HANDLE -> "pointer"
// Data : UINT_PTR -> "usize"
// Flags : QUEUE_USER_APC_FLAGS -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t QueueUserAPC2(
    void* ApcRoutine,
    void* Thread,
    size_t Data,
    int32_t Flags);
C, "KERNEL32.dll");
// $ffi->QueueUserAPC2(ApcRoutine, Thread, Data, Flags);
// ApcRoutine : PAPCFUNC
// Thread : HANDLE
// Data : UINT_PTR
// Flags : QUEUE_USER_APC_FLAGS
// 構造体/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 Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    boolean QueueUserAPC2(
        Callback ApcRoutine,   // PAPCFUNC
        Pointer Thread,   // HANDLE
        long Data,   // UINT_PTR
        int Flags   // QUEUE_USER_APC_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun QueueUserAPC2 = QueueUserAPC2(
    ApcRoutine : Void*,   # PAPCFUNC
    Thread : Void*,   # HANDLE
    Data : LibC::SizeT,   # UINT_PTR
    Flags : Int32   # QUEUE_USER_APC_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef QueueUserAPC2Native = Int32 Function(Pointer<Void>, Pointer<Void>, UintPtr, Int32);
typedef QueueUserAPC2Dart = int Function(Pointer<Void>, Pointer<Void>, int, int);
final QueueUserAPC2 = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<QueueUserAPC2Native, QueueUserAPC2Dart>('QueueUserAPC2');
// ApcRoutine : PAPCFUNC -> Pointer<Void>
// Thread : HANDLE -> Pointer<Void>
// Data : UINT_PTR -> UintPtr
// Flags : QUEUE_USER_APC_FLAGS -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function QueueUserAPC2(
  ApcRoutine: Pointer;   // PAPCFUNC
  Thread: THandle;   // HANDLE
  Data: NativeUInt;   // UINT_PTR
  Flags: Integer   // QUEUE_USER_APC_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'QueueUserAPC2';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueueUserAPC2"
  c_QueueUserAPC2 :: Ptr () -> Ptr () -> CUIntPtr -> Int32 -> IO CInt
-- ApcRoutine : PAPCFUNC -> Ptr ()
-- Thread : HANDLE -> Ptr ()
-- Data : UINT_PTR -> CUIntPtr
-- Flags : QUEUE_USER_APC_FLAGS -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let queueuserapc2 =
  foreign "QueueUserAPC2"
    ((ptr void) @-> (ptr void) @-> size_t @-> int32_t @-> returning int32_t)
(* ApcRoutine : PAPCFUNC -> (ptr void) *)
(* Thread : HANDLE -> (ptr void) *)
(* Data : UINT_PTR -> size_t *)
(* Flags : QUEUE_USER_APC_FLAGS -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("QueueUserAPC2" queue-user-apc2 :convention :stdcall) :int32
  (apc-routine :pointer)   ; PAPCFUNC
  (thread :pointer)   ; HANDLE
  (data :uint64)   ; UINT_PTR
  (flags :int32))   ; QUEUE_USER_APC_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $QueueUserAPC2 = Win32::API::More->new('KERNEL32',
    'BOOL QueueUserAPC2(LPVOID ApcRoutine, HANDLE Thread, WPARAM Data, int Flags)');
# my $ret = $QueueUserAPC2->Call($ApcRoutine, $Thread, $Data, $Flags);
# ApcRoutine : PAPCFUNC -> LPVOID
# Thread : HANDLE -> HANDLE
# Data : UINT_PTR -> WPARAM
# Flags : QUEUE_USER_APC_FLAGS -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。

関連項目

類似 API
使用する型