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

RtwqPutWaitingWorkItem

関数
イベントの通知を待って実行する作業項目を投入する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqPutWaitingWorkItem(
    HANDLE hEvent,
    INT lPriority,
    IRtwqAsyncResult* result,
    ULONGLONG* key   // optional
);

パラメーター

名前方向説明
hEventHANDLEinイベントやタイマーなどのイベントオブジェクトへのハンドル。イベントオブジェクトを作成するには、CreateEvent または CreateEventEx を呼び出します。
lPriorityINTin作業項目の優先度。作業項目は優先度の順に実行されます。
resultIRtwqAsyncResult*in非同期結果オブジェクトの IRtwqAsyncResult インターフェイスへのポインター。結果オブジェクトを作成するには、RtwqCreateAsyncResult を呼び出します。
keyULONGLONG*outoptional待機をキャンセルするために使用できるキーを受け取ります。待機をキャンセルするには、RtwqCancelWorkItem を呼び出し、このキーを Key パラメーターに渡します。このパラメーターには NULL を指定できます。

戻り値の型: HRESULT

公式ドキュメント

イベントがシグナル状態になるのを待機する作業項目をキューに登録します。(RtwqPutWaitingWorkItem)

戻り値

この関数が成功した場合は S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

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

各言語での呼び出し定義

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

HRESULT RtwqPutWaitingWorkItem(
    HANDLE hEvent,
    INT lPriority,
    IRtwqAsyncResult* result,
    ULONGLONG* key   // optional
);
[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqPutWaitingWorkItem(
    IntPtr hEvent,   // HANDLE
    int lPriority,   // INT
    IntPtr result,   // IRtwqAsyncResult*
    IntPtr key   // ULONGLONG* optional, out
);
<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqPutWaitingWorkItem(
    hEvent As IntPtr,   ' HANDLE
    lPriority As Integer,   ' INT
    result As IntPtr,   ' IRtwqAsyncResult*
    key As IntPtr   ' ULONGLONG* optional, out
) As Integer
End Function
' hEvent : HANDLE
' lPriority : INT
' result : IRtwqAsyncResult*
' key : ULONGLONG* optional, out
Declare PtrSafe Function RtwqPutWaitingWorkItem Lib "rtworkq" ( _
    ByVal hEvent As LongPtr, _
    ByVal lPriority As Long, _
    ByVal result As LongPtr, _
    ByVal key As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtwqPutWaitingWorkItem = ctypes.windll.rtworkq.RtwqPutWaitingWorkItem
RtwqPutWaitingWorkItem.restype = ctypes.c_int
RtwqPutWaitingWorkItem.argtypes = [
    wintypes.HANDLE,  # hEvent : HANDLE
    ctypes.c_int,  # lPriority : INT
    ctypes.c_void_p,  # result : IRtwqAsyncResult*
    ctypes.POINTER(ctypes.c_ulonglong),  # key : ULONGLONG* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqPutWaitingWorkItem = Fiddle::Function.new(
  lib['RtwqPutWaitingWorkItem'],
  [
    Fiddle::TYPE_VOIDP,  # hEvent : HANDLE
    Fiddle::TYPE_INT,  # lPriority : INT
    Fiddle::TYPE_VOIDP,  # result : IRtwqAsyncResult*
    Fiddle::TYPE_VOIDP,  # key : ULONGLONG* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqPutWaitingWorkItem(
        hEvent: *mut core::ffi::c_void,  // HANDLE
        lPriority: i32,  // INT
        result: *mut core::ffi::c_void,  // IRtwqAsyncResult*
        key: *mut u64  // ULONGLONG* optional, out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqPutWaitingWorkItem(IntPtr hEvent, int lPriority, IntPtr result, IntPtr key);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqPutWaitingWorkItem' -Namespace Win32 -PassThru
# $api::RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
#uselib "RTWorkQ.dll"
#func global RtwqPutWaitingWorkItem "RtwqPutWaitingWorkItem" sptr, sptr, sptr, sptr
; RtwqPutWaitingWorkItem hEvent, lPriority, result, varptr(key)   ; 戻り値は stat
; hEvent : HANDLE -> "sptr"
; lPriority : INT -> "sptr"
; result : IRtwqAsyncResult* -> "sptr"
; key : ULONGLONG* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "RTWorkQ.dll"
#cfunc global RtwqPutWaitingWorkItem "RtwqPutWaitingWorkItem" sptr, int, sptr, var
; res = RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
; hEvent : HANDLE -> "sptr"
; lPriority : INT -> "int"
; result : IRtwqAsyncResult* -> "sptr"
; key : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT RtwqPutWaitingWorkItem(HANDLE hEvent, INT lPriority, IRtwqAsyncResult* result, ULONGLONG* key)
#uselib "RTWorkQ.dll"
#cfunc global RtwqPutWaitingWorkItem "RtwqPutWaitingWorkItem" intptr, int, intptr, var
; res = RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
; hEvent : HANDLE -> "intptr"
; lPriority : INT -> "int"
; result : IRtwqAsyncResult* -> "intptr"
; key : ULONGLONG* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqPutWaitingWorkItem = rtworkq.NewProc("RtwqPutWaitingWorkItem")
)

// hEvent (HANDLE), lPriority (INT), result (IRtwqAsyncResult*), key (ULONGLONG* optional, out)
r1, _, err := procRtwqPutWaitingWorkItem.Call(
	uintptr(hEvent),
	uintptr(lPriority),
	uintptr(result),
	uintptr(key),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function RtwqPutWaitingWorkItem(
  hEvent: THandle;   // HANDLE
  lPriority: Integer;   // INT
  result: Pointer;   // IRtwqAsyncResult*
  key: Pointer   // ULONGLONG* optional, out
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqPutWaitingWorkItem';
result := DllCall("RTWorkQ\RtwqPutWaitingWorkItem"
    , "Ptr", hEvent   ; HANDLE
    , "Int", lPriority   ; INT
    , "Ptr", result   ; IRtwqAsyncResult*
    , "Ptr", key   ; ULONGLONG* optional, out
    , "Int")   ; return: HRESULT
●RtwqPutWaitingWorkItem(hEvent, lPriority, result, key) = DLL("RTWorkQ.dll", "int RtwqPutWaitingWorkItem(void*, int, void*, void*)")
# 呼び出し: RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
# hEvent : HANDLE -> "void*"
# lPriority : INT -> "int"
# result : IRtwqAsyncResult* -> "void*"
# key : ULONGLONG* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "rtworkq" fn RtwqPutWaitingWorkItem(
    hEvent: ?*anyopaque, // HANDLE
    lPriority: i32, // INT
    result: ?*anyopaque, // IRtwqAsyncResult*
    key: [*c]u64 // ULONGLONG* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc RtwqPutWaitingWorkItem(
    hEvent: pointer,  # HANDLE
    lPriority: int32,  # INT
    result: pointer,  # IRtwqAsyncResult*
    key: ptr uint64  # ULONGLONG* optional, out
): int32 {.importc: "RtwqPutWaitingWorkItem", stdcall, dynlib: "RTWorkQ.dll".}
pragma(lib, "rtworkq");
extern(Windows)
int RtwqPutWaitingWorkItem(
    void* hEvent,   // HANDLE
    int lPriority,   // INT
    void* result,   // IRtwqAsyncResult*
    ulong* key   // ULONGLONG* optional, out
);
ccall((:RtwqPutWaitingWorkItem, "RTWorkQ.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Int32, Ptr{Cvoid}, Ptr{UInt64}),
      hEvent, lPriority, result, key)
# hEvent : HANDLE -> Ptr{Cvoid}
# lPriority : INT -> Int32
# result : IRtwqAsyncResult* -> Ptr{Cvoid}
# key : ULONGLONG* optional, out -> Ptr{UInt64}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t RtwqPutWaitingWorkItem(
    void* hEvent,
    int32_t lPriority,
    void* result,
    uint64_t* key);
]]
local rtworkq = ffi.load("rtworkq")
-- rtworkq.RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
-- hEvent : HANDLE
-- lPriority : INT
-- result : IRtwqAsyncResult*
-- key : ULONGLONG* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('RTWorkQ.dll');
const RtwqPutWaitingWorkItem = lib.func('__stdcall', 'RtwqPutWaitingWorkItem', 'int32_t', ['void *', 'int32_t', 'void *', 'uint64_t *']);
// RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
// hEvent : HANDLE -> 'void *'
// lPriority : INT -> 'int32_t'
// result : IRtwqAsyncResult* -> 'void *'
// key : ULONGLONG* optional, out -> 'uint64_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("RTWorkQ.dll", {
  RtwqPutWaitingWorkItem: { parameters: ["pointer", "i32", "pointer", "pointer"], result: "i32" },
});
// lib.symbols.RtwqPutWaitingWorkItem(hEvent, lPriority, result, key)
// hEvent : HANDLE -> "pointer"
// lPriority : INT -> "i32"
// result : IRtwqAsyncResult* -> "pointer"
// key : ULONGLONG* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t RtwqPutWaitingWorkItem(
    void* hEvent,
    int32_t lPriority,
    void* result,
    uint64_t* key);
C, "RTWorkQ.dll");
// $ffi->RtwqPutWaitingWorkItem(hEvent, lPriority, result, key);
// hEvent : HANDLE
// lPriority : INT
// result : IRtwqAsyncResult*
// key : ULONGLONG* optional, out
// 構造体/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 Rtworkq extends StdCallLibrary {
    Rtworkq INSTANCE = Native.load("rtworkq", Rtworkq.class);
    int RtwqPutWaitingWorkItem(
        Pointer hEvent,   // HANDLE
        int lPriority,   // INT
        Pointer result,   // IRtwqAsyncResult*
        LongByReference key   // ULONGLONG* optional, out
    );
}
@[Link("rtworkq")]
lib LibRTWorkQ
  fun RtwqPutWaitingWorkItem = RtwqPutWaitingWorkItem(
    hEvent : Void*,   # HANDLE
    lPriority : Int32,   # INT
    result : Void*,   # IRtwqAsyncResult*
    key : UInt64*   # ULONGLONG* optional, out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef RtwqPutWaitingWorkItemNative = Int32 Function(Pointer<Void>, Int32, Pointer<Void>, Pointer<Uint64>);
typedef RtwqPutWaitingWorkItemDart = int Function(Pointer<Void>, int, Pointer<Void>, Pointer<Uint64>);
final RtwqPutWaitingWorkItem = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqPutWaitingWorkItemNative, RtwqPutWaitingWorkItemDart>('RtwqPutWaitingWorkItem');
// hEvent : HANDLE -> Pointer<Void>
// lPriority : INT -> Int32
// result : IRtwqAsyncResult* -> Pointer<Void>
// key : ULONGLONG* optional, out -> Pointer<Uint64>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqPutWaitingWorkItem(
  hEvent: THandle;   // HANDLE
  lPriority: Integer;   // INT
  result: Pointer;   // IRtwqAsyncResult*
  key: Pointer   // ULONGLONG* optional, out
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqPutWaitingWorkItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqPutWaitingWorkItem"
  c_RtwqPutWaitingWorkItem :: Ptr () -> Int32 -> Ptr () -> Ptr Word64 -> IO Int32
-- hEvent : HANDLE -> Ptr ()
-- lPriority : INT -> Int32
-- result : IRtwqAsyncResult* -> Ptr ()
-- key : ULONGLONG* optional, out -> Ptr Word64
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqputwaitingworkitem =
  foreign "RtwqPutWaitingWorkItem"
    ((ptr void) @-> int32_t @-> (ptr void) @-> (ptr uint64_t) @-> returning int32_t)
(* hEvent : HANDLE -> (ptr void) *)
(* lPriority : INT -> int32_t *)
(* result : IRtwqAsyncResult* -> (ptr void) *)
(* key : ULONGLONG* optional, out -> (ptr uint64_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

(cffi:defcfun ("RtwqPutWaitingWorkItem" rtwq-put-waiting-work-item :convention :stdcall) :int32
  (h-event :pointer)   ; HANDLE
  (l-priority :int32)   ; INT
  (result :pointer)   ; IRtwqAsyncResult*
  (key :pointer))   ; ULONGLONG* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqPutWaitingWorkItem = Win32::API::More->new('RTWorkQ',
    'int RtwqPutWaitingWorkItem(HANDLE hEvent, int lPriority, LPVOID result, LPVOID key)');
# my $ret = $RtwqPutWaitingWorkItem->Call($hEvent, $lPriority, $result, $key);
# hEvent : HANDLE -> HANDLE
# lPriority : INT -> int
# result : IRtwqAsyncResult* -> LPVOID
# key : ULONGLONG* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型