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

SubmitIoRing

関数
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 SubmitIoRing(
    HIORING ioRing,
    DWORD waitOperations,
    DWORD milliseconds,
    DWORD* submittedEntries   // optional
);

パラメーター

名前方向説明
ioRingHIORINGinエントリの送信先となる I/O リングへのハンドルを表す HIORING
waitOperationsDWORDin待機する完了キューエントリの数。0 を指定すると、呼び出しは待機しないことを示します。この値は、送信キュー内のエントリ数と現在進行中の操作数の合計より小さくする必要があります。
millisecondsDWORDin操作の完了を待機するミリ秒数。無期限に待機するには INFINITE を指定します。waitOperations に 0 を指定した場合、この値は無視されます。
submittedEntriesDWORD*outoptional省略可能。送信されたエントリ数を表す UINT_32 値の配列へのポインターを受け取ります。

戻り値の型: HRESULT

公式ドキュメント

構築済みでまだ送信されていないすべてのエントリをカーネルのキューに送信し、必要に応じて一連の操作の完了を待機します。

戻り値

以下を含む(ただしこれらに限定されない)HRESULT を返します。

説明
S_OK キュー内のすべてのエントリがエラーなく送信されました。
IORING_E_WAIT_TIMEOUT すべての操作がエラーなく送信されましたが、その後の待機がタイムアウトしました。
その他のエラー値 送信キュー全体の処理に失敗しました。

解説(Remarks)

この関数が IORING_E_WAIT_TIMEOUT 以外のエラーを返した場合、すべてのエントリは送信キューに残ります。単一の送信キューエントリの処理でエラーが発生すると、そのエントリは同期的に完了し、その操作に対するエラー状態コードとともに完了キューに送信されます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 SubmitIoRing(
    HIORING ioRing,
    DWORD waitOperations,
    DWORD milliseconds,
    DWORD* submittedEntries   // optional
);
[DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling = true)]
static extern int SubmitIoRing(
    IntPtr ioRing,   // HIORING
    uint waitOperations,   // DWORD
    uint milliseconds,   // DWORD
    IntPtr submittedEntries   // DWORD* optional, out
);
<DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function SubmitIoRing(
    ioRing As IntPtr,   ' HIORING
    waitOperations As UInteger,   ' DWORD
    milliseconds As UInteger,   ' DWORD
    submittedEntries As IntPtr   ' DWORD* optional, out
) As Integer
End Function
' ioRing : HIORING
' waitOperations : DWORD
' milliseconds : DWORD
' submittedEntries : DWORD* optional, out
Declare PtrSafe Function SubmitIoRing Lib "api-ms-win-core-ioring-l1-1-0" ( _
    ByVal ioRing As LongPtr, _
    ByVal waitOperations As Long, _
    ByVal milliseconds As Long, _
    ByVal submittedEntries As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SubmitIoRing = ctypes.windll.LoadLibrary("api-ms-win-core-ioring-l1-1-0.dll").SubmitIoRing
SubmitIoRing.restype = ctypes.c_int
SubmitIoRing.argtypes = [
    wintypes.HANDLE,  # ioRing : HIORING
    wintypes.DWORD,  # waitOperations : DWORD
    wintypes.DWORD,  # milliseconds : DWORD
    ctypes.POINTER(wintypes.DWORD),  # submittedEntries : DWORD* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-ioring-l1-1-0.dll')
SubmitIoRing = Fiddle::Function.new(
  lib['SubmitIoRing'],
  [
    Fiddle::TYPE_VOIDP,  # ioRing : HIORING
    -Fiddle::TYPE_INT,  # waitOperations : DWORD
    -Fiddle::TYPE_INT,  # milliseconds : DWORD
    Fiddle::TYPE_VOIDP,  # submittedEntries : DWORD* optional, out
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-ioring-l1-1-0")]
extern "system" {
    fn SubmitIoRing(
        ioRing: *mut core::ffi::c_void,  // HIORING
        waitOperations: u32,  // DWORD
        milliseconds: u32,  // DWORD
        submittedEntries: *mut u32  // DWORD* optional, out
    ) -> 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 SubmitIoRing(IntPtr ioRing, uint waitOperations, uint milliseconds, IntPtr submittedEntries);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-ioring-l1-1-0_SubmitIoRing' -Namespace Win32 -PassThru
# $api::SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries)
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#func global SubmitIoRing "SubmitIoRing" sptr, sptr, sptr, sptr
; SubmitIoRing ioRing, waitOperations, milliseconds, varptr(submittedEntries)   ; 戻り値は stat
; ioRing : HIORING -> "sptr"
; waitOperations : DWORD -> "sptr"
; milliseconds : DWORD -> "sptr"
; submittedEntries : DWORD* optional, out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global SubmitIoRing "SubmitIoRing" sptr, int, int, var
; res = SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries)
; ioRing : HIORING -> "sptr"
; waitOperations : DWORD -> "int"
; milliseconds : DWORD -> "int"
; submittedEntries : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; HRESULT SubmitIoRing(HIORING ioRing, DWORD waitOperations, DWORD milliseconds, DWORD* submittedEntries)
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global SubmitIoRing "SubmitIoRing" intptr, int, int, var
; res = SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries)
; ioRing : HIORING -> "intptr"
; waitOperations : DWORD -> "int"
; milliseconds : DWORD -> "int"
; submittedEntries : DWORD* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
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")
	procSubmitIoRing = api_ms_win_core_ioring_l1_1_0.NewProc("SubmitIoRing")
)

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

extern "api-ms-win-core-ioring-l1-1-0" fn SubmitIoRing(
    ioRing: ?*anyopaque, // HIORING
    waitOperations: u32, // DWORD
    milliseconds: u32, // DWORD
    submittedEntries: [*c]u32 // DWORD* optional, out
) callconv(std.os.windows.WINAPI) i32;
proc SubmitIoRing(
    ioRing: pointer,  # HIORING
    waitOperations: uint32,  # DWORD
    milliseconds: uint32,  # DWORD
    submittedEntries: ptr uint32  # DWORD* optional, out
): int32 {.importc: "SubmitIoRing", stdcall, dynlib: "api-ms-win-core-ioring-l1-1-0.dll".}
pragma(lib, "api-ms-win-core-ioring-l1-1-0");
extern(Windows)
int SubmitIoRing(
    void* ioRing,   // HIORING
    uint waitOperations,   // DWORD
    uint milliseconds,   // DWORD
    uint* submittedEntries   // DWORD* optional, out
);
ccall((:SubmitIoRing, "api-ms-win-core-ioring-l1-1-0.dll"), stdcall, Int32,
      (Ptr{Cvoid}, UInt32, UInt32, Ptr{UInt32}),
      ioRing, waitOperations, milliseconds, submittedEntries)
# ioRing : HIORING -> Ptr{Cvoid}
# waitOperations : DWORD -> UInt32
# milliseconds : DWORD -> UInt32
# submittedEntries : DWORD* optional, out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SubmitIoRing(
    void* ioRing,
    uint32_t waitOperations,
    uint32_t milliseconds,
    uint32_t* submittedEntries);
]]
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.SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries)
-- ioRing : HIORING
-- waitOperations : DWORD
-- milliseconds : DWORD
-- submittedEntries : DWORD* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('api-ms-win-core-ioring-l1-1-0.dll');
const SubmitIoRing = lib.func('__stdcall', 'SubmitIoRing', 'int32_t', ['void *', 'uint32_t', 'uint32_t', 'uint32_t *']);
// SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries)
// ioRing : HIORING -> 'void *'
// waitOperations : DWORD -> 'uint32_t'
// milliseconds : DWORD -> 'uint32_t'
// submittedEntries : DWORD* optional, out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-core-ioring-l1-1-0.dll", {
  SubmitIoRing: { parameters: ["pointer", "u32", "u32", "pointer"], result: "i32" },
});
// lib.symbols.SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries)
// ioRing : HIORING -> "pointer"
// waitOperations : DWORD -> "u32"
// milliseconds : DWORD -> "u32"
// submittedEntries : DWORD* optional, out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SubmitIoRing(
    void* ioRing,
    uint32_t waitOperations,
    uint32_t milliseconds,
    uint32_t* submittedEntries);
C, "api-ms-win-core-ioring-l1-1-0.dll");
// $ffi->SubmitIoRing(ioRing, waitOperations, milliseconds, submittedEntries);
// ioRing : HIORING
// waitOperations : DWORD
// milliseconds : DWORD
// submittedEntries : DWORD* 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 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 SubmitIoRing(
        Pointer ioRing,   // HIORING
        int waitOperations,   // DWORD
        int milliseconds,   // DWORD
        IntByReference submittedEntries   // DWORD* optional, out
    );
}
@[Link("api-ms-win-core-ioring-l1-1-0")]
lib Libapi-ms-win-core-ioring-l1-1-0
  fun SubmitIoRing = SubmitIoRing(
    ioRing : Void*,   # HIORING
    waitOperations : UInt32,   # DWORD
    milliseconds : UInt32,   # DWORD
    submittedEntries : UInt32*   # DWORD* 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 SubmitIoRingNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Pointer<Uint32>);
typedef SubmitIoRingDart = int Function(Pointer<Void>, int, int, Pointer<Uint32>);
final SubmitIoRing = DynamicLibrary.open('api-ms-win-core-ioring-l1-1-0.dll')
    .lookupFunction<SubmitIoRingNative, SubmitIoRingDart>('SubmitIoRing');
// ioRing : HIORING -> Pointer<Void>
// waitOperations : DWORD -> Uint32
// milliseconds : DWORD -> Uint32
// submittedEntries : DWORD* optional, out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SubmitIoRing(
  ioRing: THandle;   // HIORING
  waitOperations: DWORD;   // DWORD
  milliseconds: DWORD;   // DWORD
  submittedEntries: Pointer   // DWORD* optional, out
): Integer; stdcall;
  external 'api-ms-win-core-ioring-l1-1-0.dll' name 'SubmitIoRing';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SubmitIoRing"
  c_SubmitIoRing :: Ptr () -> Word32 -> Word32 -> Ptr Word32 -> IO Int32
-- ioRing : HIORING -> Ptr ()
-- waitOperations : DWORD -> Word32
-- milliseconds : DWORD -> Word32
-- submittedEntries : DWORD* optional, out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let submitioring =
  foreign "SubmitIoRing"
    ((ptr void) @-> uint32_t @-> uint32_t @-> (ptr uint32_t) @-> returning int32_t)
(* ioRing : HIORING -> (ptr void) *)
(* waitOperations : DWORD -> uint32_t *)
(* milliseconds : DWORD -> uint32_t *)
(* submittedEntries : DWORD* optional, out -> (ptr uint32_t) *)
(* 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 ("SubmitIoRing" submit-io-ring :convention :stdcall) :int32
  (io-ring :pointer)   ; HIORING
  (wait-operations :uint32)   ; DWORD
  (milliseconds :uint32)   ; DWORD
  (submitted-entries :pointer))   ; DWORD* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SubmitIoRing = Win32::API::More->new('api-ms-win-core-ioring-l1-1-0',
    'int SubmitIoRing(HANDLE ioRing, DWORD waitOperations, DWORD milliseconds, LPVOID submittedEntries)');
# my $ret = $SubmitIoRing->Call($ioRing, $waitOperations, $milliseconds, $submittedEntries);
# ioRing : HIORING -> HANDLE
# waitOperations : DWORD -> DWORD
# milliseconds : DWORD -> DWORD
# submittedEntries : DWORD* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。