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

RtwqJoinWorkQueue

関数
指定の作業キューに参加させ、関連付け用のハンドルを返す。
DLLRTWorkQ.dll呼出規約winapi対応OSWindows 8.1 以降

シグネチャ

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

HRESULT RtwqJoinWorkQueue(
    DWORD workQueueId,
    HANDLE hFile,
    HANDLE* out
);

パラメーター

名前方向説明
workQueueIdDWORDinI/O ハンドルのリダイレクト先となる作業キューの ID。
hFileHANDLEinネットワーク I/O ハンドル。
outHANDLE*outネットワークと I/O ハンドルの関連付けを表すクッキー。

戻り値の型: HRESULT

公式ドキュメント

作業キューを入出力 (I/O) ハンドルに関連付けます。

戻り値

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

RtwqJoinWorkQueue = ctypes.windll.rtworkq.RtwqJoinWorkQueue
RtwqJoinWorkQueue.restype = ctypes.c_int
RtwqJoinWorkQueue.argtypes = [
    wintypes.DWORD,  # workQueueId : DWORD
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # out : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	rtworkq = windows.NewLazySystemDLL("RTWorkQ.dll")
	procRtwqJoinWorkQueue = rtworkq.NewProc("RtwqJoinWorkQueue")
)

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

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

typedef RtwqJoinWorkQueueNative = Int32 Function(Uint32, Pointer<Void>, Pointer<Void>);
typedef RtwqJoinWorkQueueDart = int Function(int, Pointer<Void>, Pointer<Void>);
final RtwqJoinWorkQueue = DynamicLibrary.open('RTWorkQ.dll')
    .lookupFunction<RtwqJoinWorkQueueNative, RtwqJoinWorkQueueDart>('RtwqJoinWorkQueue');
// workQueueId : DWORD -> Uint32
// hFile : HANDLE -> Pointer<Void>
// out : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function RtwqJoinWorkQueue(
  workQueueId: DWORD;   // DWORD
  hFile: THandle;   // HANDLE
  out: Pointer   // HANDLE* out
): Integer; stdcall;
  external 'RTWorkQ.dll' name 'RtwqJoinWorkQueue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "RtwqJoinWorkQueue"
  c_RtwqJoinWorkQueue :: Word32 -> Ptr () -> Ptr () -> IO Int32
-- workQueueId : DWORD -> Word32
-- hFile : HANDLE -> Ptr ()
-- out : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let rtwqjoinworkqueue =
  foreign "RtwqJoinWorkQueue"
    (uint32_t @-> (ptr void) @-> (ptr void) @-> returning int32_t)
(* workQueueId : DWORD -> uint32_t *)
(* hFile : HANDLE -> (ptr void) *)
(* out : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library rtworkq (t "RTWorkQ.dll"))
(cffi:use-foreign-library rtworkq)

(cffi:defcfun ("RtwqJoinWorkQueue" rtwq-join-work-queue :convention :stdcall) :int32
  (work-queue-id :uint32)   ; DWORD
  (h-file :pointer)   ; HANDLE
  (out :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $RtwqJoinWorkQueue = Win32::API::More->new('RTWorkQ',
    'int RtwqJoinWorkQueue(DWORD workQueueId, HANDLE hFile, HANDLE out)');
# my $ret = $RtwqJoinWorkQueue->Call($workQueueId, $hFile, $out);
# workQueueId : DWORD -> DWORD
# hFile : HANDLE -> HANDLE
# out : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。