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

RtwqPutWorkItem

関数
指定の作業キューに作業項目を投入して実行を要求する。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqPutWorkItem(
    DWORD dwQueue,
    INT lPriority,
    IRtwqAsyncResult* result
);

パラメーター

名前方向説明
dwQueueDWORDinワークキューの識別子。この値には、標準のワークキューのいずれか、またはアプリが作成したワークキューを指定できます。ワークキューにアクセスするには、RtwqLockSharedWorkQueue を呼び出します。
lPriorityINTinワークアイテムの優先度。ワークアイテムは優先度の順に実行されます。この値は -1、0、または 1 のいずれかである必要があり、-1 が最も低い優先度、1 が最も高い優先度を表します。
resultIRtwqAsyncResult*inコールバックへのポインター。呼び出し元はこのインターフェイスを実装する必要があります。

戻り値の型: HRESULT

公式ドキュメント

非同期操作をワークキューに登録します。(RtwqPutWorkItem)

戻り値

この関数が成功した場合は 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 RtwqPutWorkItem(
    DWORD dwQueue,
    INT lPriority,
    IRtwqAsyncResult* result
);
[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqPutWorkItem(
    uint dwQueue,   // DWORD
    int lPriority,   // INT
    IntPtr result   // IRtwqAsyncResult*
);
<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqPutWorkItem(
    dwQueue As UInteger,   ' DWORD
    lPriority As Integer,   ' INT
    result As IntPtr   ' IRtwqAsyncResult*
) As Integer
End Function
' dwQueue : DWORD
' lPriority : INT
' result : IRtwqAsyncResult*
Declare PtrSafe Function RtwqPutWorkItem Lib "rtworkq" ( _
    ByVal dwQueue As Long, _
    ByVal lPriority As Long, _
    ByVal result As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

RtwqPutWorkItem = ctypes.windll.rtworkq.RtwqPutWorkItem
RtwqPutWorkItem.restype = ctypes.c_int
RtwqPutWorkItem.argtypes = [
    wintypes.DWORD,  # dwQueue : DWORD
    ctypes.c_int,  # lPriority : INT
    ctypes.c_void_p,  # result : IRtwqAsyncResult*
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqPutWorkItem = Fiddle::Function.new(
  lib['RtwqPutWorkItem'],
  [
    -Fiddle::TYPE_INT,  # dwQueue : DWORD
    Fiddle::TYPE_INT,  # lPriority : INT
    Fiddle::TYPE_VOIDP,  # result : IRtwqAsyncResult*
  ],
  Fiddle::TYPE_INT)
#[link(name = "rtworkq")]
extern "system" {
    fn RtwqPutWorkItem(
        dwQueue: u32,  // DWORD
        lPriority: i32,  // INT
        result: *mut core::ffi::c_void  // IRtwqAsyncResult*
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqPutWorkItem(uint dwQueue, int lPriority, IntPtr result);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqPutWorkItem' -Namespace Win32 -PassThru
# $api::RtwqPutWorkItem(dwQueue, lPriority, result)
#uselib "RTWorkQ.dll"
#func global RtwqPutWorkItem "RtwqPutWorkItem" sptr, sptr, sptr
; RtwqPutWorkItem dwQueue, lPriority, result   ; 戻り値は stat
; dwQueue : DWORD -> "sptr"
; lPriority : INT -> "sptr"
; result : IRtwqAsyncResult* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "RTWorkQ.dll"
#cfunc global RtwqPutWorkItem "RtwqPutWorkItem" int, int, sptr
; res = RtwqPutWorkItem(dwQueue, lPriority, result)
; dwQueue : DWORD -> "int"
; lPriority : INT -> "int"
; result : IRtwqAsyncResult* -> "sptr"
; HRESULT RtwqPutWorkItem(DWORD dwQueue, INT lPriority, IRtwqAsyncResult* result)
#uselib "RTWorkQ.dll"
#cfunc global RtwqPutWorkItem "RtwqPutWorkItem" int, int, intptr
; res = RtwqPutWorkItem(dwQueue, lPriority, result)
; dwQueue : DWORD -> "int"
; lPriority : INT -> "int"
; result : IRtwqAsyncResult* -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqPutWorkItem = rtworkq.NewProc("RtwqPutWorkItem")
)

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

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

typedef RtwqPutWorkItemNative = Int32 Function(Uint32, Int32, Pointer<Void>);
typedef RtwqPutWorkItemDart = int Function(int, int, Pointer<Void>);
final RtwqPutWorkItem = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqPutWorkItemNative, RtwqPutWorkItemDart>('RtwqPutWorkItem');
// dwQueue : DWORD -> Uint32
// lPriority : INT -> Int32
// result : IRtwqAsyncResult* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqPutWorkItem(
  dwQueue: DWORD;   // DWORD
  lPriority: Integer;   // INT
  result: Pointer   // IRtwqAsyncResult*
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqPutWorkItem';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqPutWorkItem"
  c_RtwqPutWorkItem :: Word32 -> Int32 -> Ptr () -> IO Int32
-- dwQueue : DWORD -> Word32
-- lPriority : INT -> Int32
-- result : IRtwqAsyncResult* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqputworkitem =
  foreign "RtwqPutWorkItem"
    (uint32_t @-> int32_t @-> (ptr void) @-> returning int32_t)
(* dwQueue : DWORD -> uint32_t *)
(* lPriority : INT -> int32_t *)
(* result : IRtwqAsyncResult* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

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

関連項目

使用する型