ホーム › System.Threading › RtwqAllocateSerialWorkQueue
RtwqAllocateSerialWorkQueue
関数順次実行用のシリアル作業キューを割り当てる。
シグネチャ
// RTWorkQ.dll
#include <windows.h>
HRESULT RtwqAllocateSerialWorkQueue(
DWORD workQueueIdIn,
DWORD* workQueueIdOut
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| workQueueIdIn | DWORD | in | 既存の作業キューの識別子。これはマルチスレッドキューまたは別のシリアル作業キューのいずれかである必要があります。次のいずれかを使用できます。
|
| workQueueIdOut | DWORD* | out | 新しいシリアル作業キューの識別子を受け取ります。作業項目をキューに入れる際にこの識別子を使用します。 |
戻り値の型: HRESULT
公式ドキュメント
作業項目のシリアル化を保証する仮想作業キューを、別の作業キューの上に作成します。シリアル作業キューは既存のマルチスレッド作業キューをラップします。シリアル作業キューは先入れ先出し (FIFO) の実行順序を強制します。
戻り値
この関数は次のいずれかの値を返すことができます。
| 戻り値コード | 説明 |
|---|---|
| 関数は成功しました。 | |
| アプリケーションが作業キューの最大数を超えました。 | |
|
アプリケーションが RtwqStartup を呼び出していないか、アプリケーションがすでに RtwqShutdown を呼び出しています。 |
解説(Remarks)
作業キューの使用が終わったら、RtwqUnlockWorkQueue を呼び出してください。
マルチスレッドキューはスレッドプールを使用するため、パイプライン内のスレッドの総数を削減できます。ただし、作業項目をシリアル化しません。シリアル作業キューを使用すると、アプリケーションは自身の作業項目の手動シリアル化を行うことなく、スレッドプールの利点を得られます。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// RTWorkQ.dll
#include <windows.h>
HRESULT RtwqAllocateSerialWorkQueue(
DWORD workQueueIdIn,
DWORD* workQueueIdOut
);[DllImport("RTWorkQ.dll", ExactSpelling = true)]
static extern int RtwqAllocateSerialWorkQueue(
uint workQueueIdIn, // DWORD
out uint workQueueIdOut // DWORD* out
);<DllImport("RTWorkQ.dll", ExactSpelling:=True)>
Public Shared Function RtwqAllocateSerialWorkQueue(
workQueueIdIn As UInteger, ' DWORD
<Out> ByRef workQueueIdOut As UInteger ' DWORD* out
) As Integer
End Function' workQueueIdIn : DWORD
' workQueueIdOut : DWORD* out
Declare PtrSafe Function RtwqAllocateSerialWorkQueue Lib "rtworkq" ( _
ByVal workQueueIdIn As Long, _
ByRef workQueueIdOut As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
RtwqAllocateSerialWorkQueue = ctypes.windll.rtworkq.RtwqAllocateSerialWorkQueue
RtwqAllocateSerialWorkQueue.restype = ctypes.c_int
RtwqAllocateSerialWorkQueue.argtypes = [
wintypes.DWORD, # workQueueIdIn : DWORD
ctypes.POINTER(wintypes.DWORD), # workQueueIdOut : DWORD* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('RTWorkQ.dll')
RtwqAllocateSerialWorkQueue = Fiddle::Function.new(
lib['RtwqAllocateSerialWorkQueue'],
[
-Fiddle::TYPE_INT, # workQueueIdIn : DWORD
Fiddle::TYPE_VOIDP, # workQueueIdOut : DWORD* out
],
Fiddle::TYPE_INT)#[link(name = "rtworkq")]
extern "system" {
fn RtwqAllocateSerialWorkQueue(
workQueueIdIn: u32, // DWORD
workQueueIdOut: *mut u32 // DWORD* out
) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("RTWorkQ.dll")]
public static extern int RtwqAllocateSerialWorkQueue(uint workQueueIdIn, out uint workQueueIdOut);
"@
$api = Add-Type -MemberDefinition $sig -Name 'RTWorkQ_RtwqAllocateSerialWorkQueue' -Namespace Win32 -PassThru
# $api::RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut)#uselib "RTWorkQ.dll"
#func global RtwqAllocateSerialWorkQueue "RtwqAllocateSerialWorkQueue" sptr, sptr
; RtwqAllocateSerialWorkQueue workQueueIdIn, varptr(workQueueIdOut) ; 戻り値は stat
; workQueueIdIn : DWORD -> "sptr"
; workQueueIdOut : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "RTWorkQ.dll" #cfunc global RtwqAllocateSerialWorkQueue "RtwqAllocateSerialWorkQueue" int, var ; res = RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut) ; workQueueIdIn : DWORD -> "int" ; workQueueIdOut : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "RTWorkQ.dll" #cfunc global RtwqAllocateSerialWorkQueue "RtwqAllocateSerialWorkQueue" int, sptr ; res = RtwqAllocateSerialWorkQueue(workQueueIdIn, varptr(workQueueIdOut)) ; workQueueIdIn : DWORD -> "int" ; workQueueIdOut : DWORD* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; HRESULT RtwqAllocateSerialWorkQueue(DWORD workQueueIdIn, DWORD* workQueueIdOut) #uselib "RTWorkQ.dll" #cfunc global RtwqAllocateSerialWorkQueue "RtwqAllocateSerialWorkQueue" int, var ; res = RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut) ; workQueueIdIn : DWORD -> "int" ; workQueueIdOut : DWORD* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; HRESULT RtwqAllocateSerialWorkQueue(DWORD workQueueIdIn, DWORD* workQueueIdOut) #uselib "RTWorkQ.dll" #cfunc global RtwqAllocateSerialWorkQueue "RtwqAllocateSerialWorkQueue" int, intptr ; res = RtwqAllocateSerialWorkQueue(workQueueIdIn, varptr(workQueueIdOut)) ; workQueueIdIn : DWORD -> "int" ; workQueueIdOut : DWORD* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
procRtwqAllocateSerialWorkQueue = rtworkq.NewProc("RtwqAllocateSerialWorkQueue")
)
// workQueueIdIn (DWORD), workQueueIdOut (DWORD* out)
r1, _, err := procRtwqAllocateSerialWorkQueue.Call(
uintptr(workQueueIdIn),
uintptr(workQueueIdOut),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // HRESULTfunction RtwqAllocateSerialWorkQueue(
workQueueIdIn: DWORD; // DWORD
workQueueIdOut: Pointer // DWORD* out
): Integer; stdcall;
external 'RTWorkQ.dll' name 'RtwqAllocateSerialWorkQueue';result := DllCall("RTWorkQ\RtwqAllocateSerialWorkQueue"
, "UInt", workQueueIdIn ; DWORD
, "Ptr", workQueueIdOut ; DWORD* out
, "Int") ; return: HRESULT●RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut) = DLL("RTWorkQ.dll", "int RtwqAllocateSerialWorkQueue(dword, void*)")
# 呼び出し: RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut)
# workQueueIdIn : DWORD -> "dword"
# workQueueIdOut : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "rtworkq" fn RtwqAllocateSerialWorkQueue(
workQueueIdIn: u32, // DWORD
workQueueIdOut: [*c]u32 // DWORD* out
) callconv(std.os.windows.WINAPI) i32;proc RtwqAllocateSerialWorkQueue(
workQueueIdIn: uint32, # DWORD
workQueueIdOut: ptr uint32 # DWORD* out
): int32 {.importc: "RtwqAllocateSerialWorkQueue", stdcall, dynlib: "RTWorkQ.dll".}pragma(lib, "rtworkq");
extern(Windows)
int RtwqAllocateSerialWorkQueue(
uint workQueueIdIn, // DWORD
uint* workQueueIdOut // DWORD* out
);ccall((:RtwqAllocateSerialWorkQueue, "RTWorkQ.dll"), stdcall, Int32,
(UInt32, Ptr{UInt32}),
workQueueIdIn, workQueueIdOut)
# workQueueIdIn : DWORD -> UInt32
# workQueueIdOut : DWORD* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
int32_t RtwqAllocateSerialWorkQueue(
uint32_t workQueueIdIn,
uint32_t* workQueueIdOut);
]]
local rtworkq = ffi.load("rtworkq")
-- rtworkq.RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut)
-- workQueueIdIn : DWORD
-- workQueueIdOut : DWORD* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('RTWorkQ.dll');
const RtwqAllocateSerialWorkQueue = lib.func('__stdcall', 'RtwqAllocateSerialWorkQueue', 'int32_t', ['uint32_t', 'uint32_t *']);
// RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut)
// workQueueIdIn : DWORD -> 'uint32_t'
// workQueueIdOut : DWORD* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("RTWorkQ.dll", {
RtwqAllocateSerialWorkQueue: { parameters: ["u32", "pointer"], result: "i32" },
});
// lib.symbols.RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut)
// workQueueIdIn : DWORD -> "u32"
// workQueueIdOut : DWORD* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
int32_t RtwqAllocateSerialWorkQueue(
uint32_t workQueueIdIn,
uint32_t* workQueueIdOut);
C, "RTWorkQ.dll");
// $ffi->RtwqAllocateSerialWorkQueue(workQueueIdIn, workQueueIdOut);
// workQueueIdIn : DWORD
// workQueueIdOut : DWORD* 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 RtwqAllocateSerialWorkQueue(
int workQueueIdIn, // DWORD
IntByReference workQueueIdOut // DWORD* out
);
}@[Link("rtworkq")]
lib LibRTWorkQ
fun RtwqAllocateSerialWorkQueue = RtwqAllocateSerialWorkQueue(
workQueueIdIn : UInt32, # DWORD
workQueueIdOut : UInt32* # DWORD* out
) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef RtwqAllocateSerialWorkQueueNative = Int32 Function(Uint32, Pointer<Uint32>);
typedef RtwqAllocateSerialWorkQueueDart = int Function(int, Pointer<Uint32>);
final RtwqAllocateSerialWorkQueue = DynamicLibrary.open('RTWorkQ.dll')
.lookupFunction<RtwqAllocateSerialWorkQueueNative, RtwqAllocateSerialWorkQueueDart>('RtwqAllocateSerialWorkQueue');
// workQueueIdIn : DWORD -> Uint32
// workQueueIdOut : DWORD* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function RtwqAllocateSerialWorkQueue(
workQueueIdIn: DWORD; // DWORD
workQueueIdOut: Pointer // DWORD* out
): Integer; stdcall;
external 'RTWorkQ.dll' name 'RtwqAllocateSerialWorkQueue';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "RtwqAllocateSerialWorkQueue"
c_RtwqAllocateSerialWorkQueue :: Word32 -> Ptr Word32 -> IO Int32
-- workQueueIdIn : DWORD -> Word32
-- workQueueIdOut : DWORD* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let rtwqallocateserialworkqueue =
foreign "RtwqAllocateSerialWorkQueue"
(uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* workQueueIdIn : DWORD -> uint32_t *)
(* workQueueIdOut : DWORD* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)
(cffi:defcfun ("RtwqAllocateSerialWorkQueue" rtwq-allocate-serial-work-queue :convention :stdcall) :int32
(work-queue-id-in :uint32) ; DWORD
(work-queue-id-out :pointer)) ; DWORD* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $RtwqAllocateSerialWorkQueue = Win32::API::More->new('RTWorkQ',
'int RtwqAllocateSerialWorkQueue(DWORD workQueueIdIn, LPVOID workQueueIdOut)');
# my $ret = $RtwqAllocateSerialWorkQueue->Call($workQueueIdIn, $workQueueIdOut);
# workQueueIdIn : DWORD -> DWORD
# workQueueIdOut : DWORD* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
公式の関連項目