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

PopIoRingCompletion

関数
I/Oリングの完了キューから完了エントリ(CQE)を1件取り出す。
DLLapi-ms-win-core-ioring-l1-1-0.dll呼出規約winapi

シグネチャ

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

HRESULT PopIoRingCompletion(
    HIORING ioRing,
    IORING_CQE* cqe
);

パラメーター

名前方向説明
ioRingHIORINGin完了キューからエントリを取り出す対象の I/O リングへのハンドルを表す HIORING
cqeIORING_CQE*out完了したキューエントリのデータを受け取る IORING_CQE 構造体へのポインター。

戻り値の型: HRESULT

公式ドキュメント

完了キューからエントリを1つ取り出します(利用可能な場合)。

戻り値

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

説明
S_OK エントリがキューから取り出され、cqe が指す IORING_CQE にそのエントリの値が格納されています。
S_FALSE 完了キューが空であり、cqe パラメーターが指すデータは変更されません。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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 PopIoRingCompletion(
    HIORING ioRing,
    IORING_CQE* cqe
);
[DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling = true)]
static extern int PopIoRingCompletion(
    IntPtr ioRing,   // HIORING
    IntPtr cqe   // IORING_CQE* out
);
<DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function PopIoRingCompletion(
    ioRing As IntPtr,   ' HIORING
    cqe As IntPtr   ' IORING_CQE* out
) As Integer
End Function
' ioRing : HIORING
' cqe : IORING_CQE* out
Declare PtrSafe Function PopIoRingCompletion Lib "api-ms-win-core-ioring-l1-1-0" ( _
    ByVal ioRing As LongPtr, _
    ByVal cqe As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

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

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

// ioRing (HIORING), cqe (IORING_CQE* out)
r1, _, err := procPopIoRingCompletion.Call(
	uintptr(ioRing),
	uintptr(cqe),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function PopIoRingCompletion(
  ioRing: THandle;   // HIORING
  cqe: Pointer   // IORING_CQE* out
): Integer; stdcall;
  external 'api-ms-win-core-ioring-l1-1-0.dll' name 'PopIoRingCompletion';
result := DllCall("api-ms-win-core-ioring-l1-1-0\PopIoRingCompletion"
    , "Ptr", ioRing   ; HIORING
    , "Ptr", cqe   ; IORING_CQE* out
    , "Int")   ; return: HRESULT
●PopIoRingCompletion(ioRing, cqe) = DLL("api-ms-win-core-ioring-l1-1-0.dll", "int PopIoRingCompletion(void*, void*)")
# 呼び出し: PopIoRingCompletion(ioRing, cqe)
# ioRing : HIORING -> "void*"
# cqe : IORING_CQE* 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 PopIoRingCompletion(
    ioRing: ?*anyopaque, // HIORING
    cqe: [*c]IORING_CQE // IORING_CQE* out
) callconv(std.os.windows.WINAPI) i32;
proc PopIoRingCompletion(
    ioRing: pointer,  # HIORING
    cqe: ptr IORING_CQE  # IORING_CQE* out
): int32 {.importc: "PopIoRingCompletion", stdcall, dynlib: "api-ms-win-core-ioring-l1-1-0.dll".}
pragma(lib, "api-ms-win-core-ioring-l1-1-0");
extern(Windows)
int PopIoRingCompletion(
    void* ioRing,   // HIORING
    IORING_CQE* cqe   // IORING_CQE* out
);
ccall((:PopIoRingCompletion, "api-ms-win-core-ioring-l1-1-0.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Ptr{IORING_CQE}),
      ioRing, cqe)
# ioRing : HIORING -> Ptr{Cvoid}
# cqe : IORING_CQE* out -> Ptr{IORING_CQE}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t PopIoRingCompletion(
    void* ioRing,
    void* cqe);
]]
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.PopIoRingCompletion(ioRing, cqe)
-- ioRing : HIORING
-- cqe : IORING_CQE* 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 PopIoRingCompletion = lib.func('__stdcall', 'PopIoRingCompletion', 'int32_t', ['void *', 'void *']);
// PopIoRingCompletion(ioRing, cqe)
// ioRing : HIORING -> 'void *'
// cqe : IORING_CQE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-core-ioring-l1-1-0.dll", {
  PopIoRingCompletion: { parameters: ["pointer", "pointer"], result: "i32" },
});
// lib.symbols.PopIoRingCompletion(ioRing, cqe)
// ioRing : HIORING -> "pointer"
// cqe : IORING_CQE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t PopIoRingCompletion(
    void* ioRing,
    void* cqe);
C, "api-ms-win-core-ioring-l1-1-0.dll");
// $ffi->PopIoRingCompletion(ioRing, cqe);
// ioRing : HIORING
// cqe : IORING_CQE* 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 PopIoRingCompletion(
        Pointer ioRing,   // HIORING
        Pointer cqe   // IORING_CQE* out
    );
}
@[Link("api-ms-win-core-ioring-l1-1-0")]
lib Libapi-ms-win-core-ioring-l1-1-0
  fun PopIoRingCompletion = PopIoRingCompletion(
    ioRing : Void*,   # HIORING
    cqe : IORING_CQE*   # IORING_CQE* out
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

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

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

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

関連項目

使用する型