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

BuildIoRingRegisterFileHandles

関数
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 BuildIoRingRegisterFileHandles(
    HIORING ioRing,
    DWORD count,
    const HANDLE* handles,
    UINT_PTR userData
);

パラメーター

名前方向説明
ioRingHIORINGinファイルハンドルを登録する対象の I/O リングへのハンドルを表す HIORING です。
countDWORDinhandles パラメーターで指定されたハンドルの数を表す UINT32 です。
handlesHANDLE*in登録する HANDLE 値の配列です。
userDataUINT_PTRin登録操作を識別する UINT_PTR 値です。BuildIoRingCancelRequest の呼び出しで操作をキャンセルする際にこの値を指定します。アプリが操作のキャンセル動作を実装する場合、userData 値は一意でなければなりません。それ以外の場合、この値はシステムによって不透明な値として扱われ、0 を含む任意の値を指定できます。

戻り値の型: HRESULT

公式ドキュメント

将来の I/O リング操作のために、ファイルハンドルの配列をシステムに登録します。

戻り値

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

説明
S_OK 成功
IORING_E_SUBMISSION_QUEUE_FULL 送信キューが満杯で、構築可能な追加エントリがありません。アプリケーションは既存のエントリを送信し、それらのいくつかが完了するのを待ってから、キューに操作を追加する必要があります。
IORING_E_UNKNOWN_REQUIRED_FLAG アプリケーションが、実装に認識されない必須フラグを指定しました。ライブラリコードは、GetIoRingInfo の呼び出しで取得した IORING_INFOIoRingVersion フィールドを確認して、I/O リングの API バージョンを判別する必要があります。これにより、サポートされる操作とフラグが決まります。アプリケーションは I/O リングの作成に使用したバージョンを把握しているはずであり、したがって実行時にサポートされていないフラグを指定すべきではありません。

解説(Remarks)

この関数により、カーネル実装は検証と内部マッピングを一度だけ実行できるため、各 I/O 操作ごとのオーバーヘッドを回避できます。送信キュー内の後続のエントリは、この関数で登録したハンドルを、配列への整数インデックスを使用して参照できます。以前の登録が存在する場合、それは以前の登録を完全に置き換えます。

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

BuildIoRingRegisterFileHandles = ctypes.windll.LoadLibrary("api-ms-win-core-ioring-l1-1-0.dll").BuildIoRingRegisterFileHandles
BuildIoRingRegisterFileHandles.restype = ctypes.c_int
BuildIoRingRegisterFileHandles.argtypes = [
    wintypes.HANDLE,  # ioRing : HIORING
    wintypes.DWORD,  # count : DWORD
    ctypes.c_void_p,  # handles : HANDLE*
    ctypes.c_size_t,  # userData : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-ioring-l1-1-0.dll')
BuildIoRingRegisterFileHandles = Fiddle::Function.new(
  lib['BuildIoRingRegisterFileHandles'],
  [
    Fiddle::TYPE_VOIDP,  # ioRing : HIORING
    -Fiddle::TYPE_INT,  # count : DWORD
    Fiddle::TYPE_VOIDP,  # handles : HANDLE*
    Fiddle::TYPE_UINTPTR_T,  # userData : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-ioring-l1-1-0")]
extern "system" {
    fn BuildIoRingRegisterFileHandles(
        ioRing: *mut core::ffi::c_void,  // HIORING
        count: u32,  // DWORD
        handles: *mut *mut core::ffi::c_void,  // HANDLE*
        userData: usize  // UINT_PTR
    ) -> 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 BuildIoRingRegisterFileHandles(IntPtr ioRing, uint count, IntPtr handles, UIntPtr userData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-ioring-l1-1-0_BuildIoRingRegisterFileHandles' -Namespace Win32 -PassThru
# $api::BuildIoRingRegisterFileHandles(ioRing, count, handles, userData)
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#func global BuildIoRingRegisterFileHandles "BuildIoRingRegisterFileHandles" sptr, sptr, sptr, sptr
; BuildIoRingRegisterFileHandles ioRing, count, handles, userData   ; 戻り値は stat
; ioRing : HIORING -> "sptr"
; count : DWORD -> "sptr"
; handles : HANDLE* -> "sptr"
; userData : UINT_PTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global BuildIoRingRegisterFileHandles "BuildIoRingRegisterFileHandles" sptr, int, sptr, sptr
; res = BuildIoRingRegisterFileHandles(ioRing, count, handles, userData)
; ioRing : HIORING -> "sptr"
; count : DWORD -> "int"
; handles : HANDLE* -> "sptr"
; userData : UINT_PTR -> "sptr"
; HRESULT BuildIoRingRegisterFileHandles(HIORING ioRing, DWORD count, HANDLE* handles, UINT_PTR userData)
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global BuildIoRingRegisterFileHandles "BuildIoRingRegisterFileHandles" intptr, int, intptr, intptr
; res = BuildIoRingRegisterFileHandles(ioRing, count, handles, userData)
; ioRing : HIORING -> "intptr"
; count : DWORD -> "int"
; handles : HANDLE* -> "intptr"
; userData : UINT_PTR -> "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")
	procBuildIoRingRegisterFileHandles = api_ms_win_core_ioring_l1_1_0.NewProc("BuildIoRingRegisterFileHandles")
)

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

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

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

foreign import stdcall safe "BuildIoRingRegisterFileHandles"
  c_BuildIoRingRegisterFileHandles :: Ptr () -> Word32 -> Ptr () -> CUIntPtr -> IO Int32
-- ioRing : HIORING -> Ptr ()
-- count : DWORD -> Word32
-- handles : HANDLE* -> Ptr ()
-- userData : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let buildioringregisterfilehandles =
  foreign "BuildIoRingRegisterFileHandles"
    ((ptr void) @-> uint32_t @-> (ptr void) @-> size_t @-> returning int32_t)
(* ioRing : HIORING -> (ptr void) *)
(* count : DWORD -> uint32_t *)
(* handles : HANDLE* -> (ptr void) *)
(* userData : UINT_PTR -> size_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 ("BuildIoRingRegisterFileHandles" build-io-ring-register-file-handles :convention :stdcall) :int32
  (io-ring :pointer)   ; HIORING
  (count :uint32)   ; DWORD
  (handles :pointer)   ; HANDLE*
  (user-data :uint64))   ; UINT_PTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $BuildIoRingRegisterFileHandles = Win32::API::More->new('api-ms-win-core-ioring-l1-1-0',
    'int BuildIoRingRegisterFileHandles(HANDLE ioRing, DWORD count, HANDLE handles, WPARAM userData)');
# my $ret = $BuildIoRingRegisterFileHandles->Call($ioRing, $count, $handles, $userData);
# ioRing : HIORING -> HANDLE
# count : DWORD -> DWORD
# handles : HANDLE* -> HANDLE
# userData : UINT_PTR -> WPARAM
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。