Win32 API 日本語リファレンス
ホームStorage.FileSystem › SetIoRingCompletionEvent

SetIoRingCompletionEvent

関数
I/Oリングの完了通知に使うイベントハンドルを設定する。
DLLapi-ms-win-core-ioring-l1-1-0.dll呼出規約winapi

シグネチャ

// api-ms-win-core-ioring-l1-1-0.dll
#include <windows.h>

HRESULT SetIoRingCompletionEvent(
    HIORING ioRing,
    HANDLE hEvent
);

パラメーター

名前方向説明
ioRingHIORINGin完了イベントを登録する I/O リングへのハンドルを表す HIORING です。
hEventHANDLEinイベントオブジェクトへのハンドルです。CreateEvent 関数または OpenEvent 関数がこのハンドルを返します。

戻り値の型: HRESULT

公式ドキュメント

完了キューイベントを IORING に登録します。

戻り値

次の値を含む HRESULT を返します。

説明
S_OK 成功
E_INVALID_HANDLE ioRing パラメーターに無効なハンドルが渡されました。
E_INVALIDARG hEvent パラメーターに無効なハンドルが渡されました。

解説(Remarks)

カーネルは、空の完了キューに最初のエントリを配置したときにこのイベントをシグナル状態にします。つまり、カーネルは完了キューが空から空でない状態へ遷移したときにのみイベントをシグナル状態に設定します。アプリケーションは、エントリがなくなったことが示されるまで PopIoRingCompletion を呼び出し、その後、提供された HANDLE を介して追加の非同期完了が完了するのを待機する必要があります。そうしないと、イベントがシグナル状態に入らず、タイムアウトが発生するまで、または無限タイムアウトが使用されている場合は永久に待機がブロックされる可能性があります。

カーネルは内部でハンドルを複製するため、待機が不要になった時点でアプリケーションがハンドルを閉じても安全です。イベントハンドルの値として NULL を指定すると、既存の値が単にクリアされます。INVALID_HANDLE_VALUE の値を設定するとエラーが発生し、その他の無効なハンドル値でも同様にエラーが発生します。これはコードのバグを早期に検出するのに役立ちます。

HIORING に関連付けられるイベントハンドルは最大で 1 つです。2 つ目を設定しようとすると、既に存在するものが置き換えられます。

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

各言語での呼び出し定義

// api-ms-win-core-ioring-l1-1-0.dll
#include <windows.h>

HRESULT SetIoRingCompletionEvent(
    HIORING ioRing,
    HANDLE hEvent
);
[DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling = true)]
static extern int SetIoRingCompletionEvent(
    IntPtr ioRing,   // HIORING
    IntPtr hEvent   // HANDLE
);
<DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function SetIoRingCompletionEvent(
    ioRing As IntPtr,   ' HIORING
    hEvent As IntPtr   ' HANDLE
) As Integer
End Function
' ioRing : HIORING
' hEvent : HANDLE
Declare PtrSafe Function SetIoRingCompletionEvent Lib "api-ms-win-core-ioring-l1-1-0" ( _
    ByVal ioRing As LongPtr, _
    ByVal hEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetIoRingCompletionEvent = ctypes.windll.LoadLibrary("api-ms-win-core-ioring-l1-1-0.dll").SetIoRingCompletionEvent
SetIoRingCompletionEvent.restype = ctypes.c_int
SetIoRingCompletionEvent.argtypes = [
    wintypes.HANDLE,  # ioRing : HIORING
    wintypes.HANDLE,  # hEvent : HANDLE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	api_ms_win_core_ioring_l1_1_0 = windows.NewLazySystemDLL("api-ms-win-core-ioring-l1-1-0.dll")
	procSetIoRingCompletionEvent = api_ms_win_core_ioring_l1_1_0.NewProc("SetIoRingCompletionEvent")
)

// ioRing (HIORING), hEvent (HANDLE)
r1, _, err := procSetIoRingCompletionEvent.Call(
	uintptr(ioRing),
	uintptr(hEvent),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function SetIoRingCompletionEvent(
  ioRing: THandle;   // HIORING
  hEvent: THandle   // HANDLE
): Integer; stdcall;
  external 'api-ms-win-core-ioring-l1-1-0.dll' name 'SetIoRingCompletionEvent';
result := DllCall("api-ms-win-core-ioring-l1-1-0\SetIoRingCompletionEvent"
    , "Ptr", ioRing   ; HIORING
    , "Ptr", hEvent   ; HANDLE
    , "Int")   ; return: HRESULT
●SetIoRingCompletionEvent(ioRing, hEvent) = DLL("api-ms-win-core-ioring-l1-1-0.dll", "int SetIoRingCompletionEvent(void*, void*)")
# 呼び出し: SetIoRingCompletionEvent(ioRing, hEvent)
# ioRing : HIORING -> "void*"
# hEvent : HANDLE -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetIoRingCompletionEventNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef SetIoRingCompletionEventDart = int Function(Pointer<Void>, Pointer<Void>);
final SetIoRingCompletionEvent = DynamicLibrary.open('api-ms-win-core-ioring-l1-1-0.dll')
    .lookupFunction<SetIoRingCompletionEventNative, SetIoRingCompletionEventDart>('SetIoRingCompletionEvent');
// ioRing : HIORING -> Pointer<Void>
// hEvent : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetIoRingCompletionEvent(
  ioRing: THandle;   // HIORING
  hEvent: THandle   // HANDLE
): Integer; stdcall;
  external 'api-ms-win-core-ioring-l1-1-0.dll' name 'SetIoRingCompletionEvent';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetIoRingCompletionEvent"
  c_SetIoRingCompletionEvent :: Ptr () -> Ptr () -> IO Int32
-- ioRing : HIORING -> Ptr ()
-- hEvent : HANDLE -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setioringcompletionevent =
  foreign "SetIoRingCompletionEvent"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* ioRing : HIORING -> (ptr void) *)
(* hEvent : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library api-ms-win-core-ioring-l1-1-0 (t "api-ms-win-core-ioring-l1-1-0.dll"))
(cffi:use-foreign-library api-ms-win-core-ioring-l1-1-0)

(cffi:defcfun ("SetIoRingCompletionEvent" set-io-ring-completion-event :convention :stdcall) :int32
  (io-ring :pointer)   ; HIORING
  (h-event :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetIoRingCompletionEvent = Win32::API::More->new('api-ms-win-core-ioring-l1-1-0',
    'int SetIoRingCompletionEvent(HANDLE ioRing, HANDLE hEvent)');
# my $ret = $SetIoRingCompletionEvent->Call($ioRing, $hEvent);
# ioRing : HIORING -> HANDLE
# hEvent : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。