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

BuildIoRingCancelRequest

関数
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 BuildIoRingCancelRequest(
    HIORING ioRing,
    IORING_HANDLE_REF file,
    UINT_PTR opToCancel,
    UINT_PTR userData
);

パラメーター

名前方向説明
ioRingHIORINGinキャンセルを要求する対象の I/O リングへのハンドルを表す HIORING
fileIORING_HANDLE_REFinキャンセルする操作に関連付けられたファイルを表す IORING_HANDLE_REF
opToCancelUINT_PTRinキャンセルする操作を指定する UINT_PTR。この値は、操作を登録したときに userData パラメーターに指定した値と同じです。キャンセルをサポートするには、userData の値が操作ごとに一意である必要があります。
userDataUINT_PTRinキャンセル操作を識別する UINT_PTR 値。BuildIoRingCancelRequest の呼び出しで操作をキャンセルする際にこの値を指定します。アプリが操作に対してキャンセル動作を実装する場合、userData の値は一意である必要があります。それ以外の場合、この値はシステムによって不透明な値として扱われ、0 を含む任意の値を指定できます。

戻り値の型: HRESULT

公式ドキュメント

以前に送信された I/O リング操作のキャンセルを試みます。

戻り値

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

解説(Remarks)

I/O リング操作は非同期に実行されるため、この関数呼び出しはキャンセルの要求にすぎません。指定した操作は、キャンセルが処理される前に完了する場合があります。また、キャンセル操作は、キャンセル対象の操作が完了した後に完了する場合があります。キャンセル操作の完了は、それがキャンセルする I/O 操作の実際の完了に依存しません。アプリは、PopIoRingCompletion を呼び出して完了キューで元の操作の完了を確認し、操作の最終的な状態を観察する必要があります。操作は、この関数の呼び出しによってキャンセルされるのではなく、正常に完了している場合やエラーで完了している場合があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 BuildIoRingCancelRequest(
    HIORING ioRing,
    IORING_HANDLE_REF file,
    UINT_PTR opToCancel,
    UINT_PTR userData
);
[DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling = true)]
static extern int BuildIoRingCancelRequest(
    IntPtr ioRing,   // HIORING
    IORING_HANDLE_REF file,   // IORING_HANDLE_REF
    UIntPtr opToCancel,   // UINT_PTR
    UIntPtr userData   // UINT_PTR
);
<DllImport("api-ms-win-core-ioring-l1-1-0.dll", ExactSpelling:=True)>
Public Shared Function BuildIoRingCancelRequest(
    ioRing As IntPtr,   ' HIORING
    file As IORING_HANDLE_REF,   ' IORING_HANDLE_REF
    opToCancel As UIntPtr,   ' UINT_PTR
    userData As UIntPtr   ' UINT_PTR
) As Integer
End Function
' ioRing : HIORING
' file : IORING_HANDLE_REF
' opToCancel : UINT_PTR
' userData : UINT_PTR
Declare PtrSafe Function BuildIoRingCancelRequest Lib "api-ms-win-core-ioring-l1-1-0" ( _
    ByVal ioRing As LongPtr, _
    ByVal file As LongPtr, _
    ByVal opToCancel 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

BuildIoRingCancelRequest = ctypes.windll.LoadLibrary("api-ms-win-core-ioring-l1-1-0.dll").BuildIoRingCancelRequest
BuildIoRingCancelRequest.restype = ctypes.c_int
BuildIoRingCancelRequest.argtypes = [
    wintypes.HANDLE,  # ioRing : HIORING
    IORING_HANDLE_REF,  # file : IORING_HANDLE_REF
    ctypes.c_size_t,  # opToCancel : UINT_PTR
    ctypes.c_size_t,  # userData : UINT_PTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-ioring-l1-1-0.dll')
BuildIoRingCancelRequest = Fiddle::Function.new(
  lib['BuildIoRingCancelRequest'],
  [
    Fiddle::TYPE_VOIDP,  # ioRing : HIORING
    Fiddle::TYPE_VOIDP,  # file : IORING_HANDLE_REF
    Fiddle::TYPE_UINTPTR_T,  # opToCancel : UINT_PTR
    Fiddle::TYPE_UINTPTR_T,  # userData : UINT_PTR
  ],
  Fiddle::TYPE_INT)
#[link(name = "api-ms-win-core-ioring-l1-1-0")]
extern "system" {
    fn BuildIoRingCancelRequest(
        ioRing: *mut core::ffi::c_void,  // HIORING
        file: IORING_HANDLE_REF,  // IORING_HANDLE_REF
        opToCancel: usize,  // UINT_PTR
        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 BuildIoRingCancelRequest(IntPtr ioRing, IORING_HANDLE_REF file, UIntPtr opToCancel, UIntPtr userData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-ioring-l1-1-0_BuildIoRingCancelRequest' -Namespace Win32 -PassThru
# $api::BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#func global BuildIoRingCancelRequest "BuildIoRingCancelRequest" sptr, sptr, sptr, sptr
; BuildIoRingCancelRequest ioRing, file, opToCancel, userData   ; 戻り値は stat
; ioRing : HIORING -> "sptr"
; file : IORING_HANDLE_REF -> "sptr"
; opToCancel : UINT_PTR -> "sptr"
; userData : UINT_PTR -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global BuildIoRingCancelRequest "BuildIoRingCancelRequest" sptr, int, sptr, sptr
; res = BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
; ioRing : HIORING -> "sptr"
; file : IORING_HANDLE_REF -> "int"
; opToCancel : UINT_PTR -> "sptr"
; userData : UINT_PTR -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; HRESULT BuildIoRingCancelRequest(HIORING ioRing, IORING_HANDLE_REF file, UINT_PTR opToCancel, UINT_PTR userData)
#uselib "api-ms-win-core-ioring-l1-1-0.dll"
#cfunc global BuildIoRingCancelRequest "BuildIoRingCancelRequest" intptr, int, intptr, intptr
; res = BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
; ioRing : HIORING -> "intptr"
; file : IORING_HANDLE_REF -> "int"
; opToCancel : UINT_PTR -> "intptr"
; userData : UINT_PTR -> "intptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
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")
	procBuildIoRingCancelRequest = api_ms_win_core_ioring_l1_1_0.NewProc("BuildIoRingCancelRequest")
)

// ioRing (HIORING), file (IORING_HANDLE_REF), opToCancel (UINT_PTR), userData (UINT_PTR)
r1, _, err := procBuildIoRingCancelRequest.Call(
	uintptr(ioRing),
	uintptr(file),
	uintptr(opToCancel),
	uintptr(userData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // HRESULT
function BuildIoRingCancelRequest(
  ioRing: THandle;   // HIORING
  file: IORING_HANDLE_REF;   // IORING_HANDLE_REF
  opToCancel: NativeUInt;   // UINT_PTR
  userData: NativeUInt   // UINT_PTR
): Integer; stdcall;
  external 'api-ms-win-core-ioring-l1-1-0.dll' name 'BuildIoRingCancelRequest';
result := DllCall("api-ms-win-core-ioring-l1-1-0\BuildIoRingCancelRequest"
    , "Ptr", ioRing   ; HIORING
    , "Ptr", file   ; IORING_HANDLE_REF
    , "UPtr", opToCancel   ; UINT_PTR
    , "UPtr", userData   ; UINT_PTR
    , "Int")   ; return: HRESULT
●BuildIoRingCancelRequest(ioRing, file, opToCancel, userData) = DLL("api-ms-win-core-ioring-l1-1-0.dll", "int BuildIoRingCancelRequest(void*, void*, int, int)")
# 呼び出し: BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
# ioRing : HIORING -> "void*"
# file : IORING_HANDLE_REF -> "void*"
# opToCancel : UINT_PTR -> "int"
# 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 BuildIoRingCancelRequest(
    ioRing: ?*anyopaque, // HIORING
    file: IORING_HANDLE_REF, // IORING_HANDLE_REF
    opToCancel: usize, // UINT_PTR
    userData: usize // UINT_PTR
) callconv(std.os.windows.WINAPI) i32;
proc BuildIoRingCancelRequest(
    ioRing: pointer,  # HIORING
    file: IORING_HANDLE_REF,  # IORING_HANDLE_REF
    opToCancel: uint,  # UINT_PTR
    userData: uint  # UINT_PTR
): int32 {.importc: "BuildIoRingCancelRequest", stdcall, dynlib: "api-ms-win-core-ioring-l1-1-0.dll".}
pragma(lib, "api-ms-win-core-ioring-l1-1-0");
extern(Windows)
int BuildIoRingCancelRequest(
    void* ioRing,   // HIORING
    IORING_HANDLE_REF file,   // IORING_HANDLE_REF
    size_t opToCancel,   // UINT_PTR
    size_t userData   // UINT_PTR
);
ccall((:BuildIoRingCancelRequest, "api-ms-win-core-ioring-l1-1-0.dll"), stdcall, Int32,
      (Ptr{Cvoid}, IORING_HANDLE_REF, Csize_t, Csize_t),
      ioRing, file, opToCancel, userData)
# ioRing : HIORING -> Ptr{Cvoid}
# file : IORING_HANDLE_REF -> IORING_HANDLE_REF
# opToCancel : UINT_PTR -> Csize_t
# userData : UINT_PTR -> Csize_t
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t BuildIoRingCancelRequest(
    void* ioRing,
    IORING_HANDLE_REF file,
    uintptr_t opToCancel,
    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.BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
-- ioRing : HIORING
-- file : IORING_HANDLE_REF
-- opToCancel : UINT_PTR
-- 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 BuildIoRingCancelRequest = lib.func('__stdcall', 'BuildIoRingCancelRequest', 'int32_t', ['void *', 'IORING_HANDLE_REF', 'uintptr_t', 'uintptr_t']);
// BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
// ioRing : HIORING -> 'void *'
// file : IORING_HANDLE_REF -> 'IORING_HANDLE_REF'
// opToCancel : UINT_PTR -> 'uintptr_t'
// userData : UINT_PTR -> 'uintptr_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("api-ms-win-core-ioring-l1-1-0.dll", {
  BuildIoRingCancelRequest: { parameters: ["pointer", "buffer", "usize", "usize"], result: "i32" },
});
// lib.symbols.BuildIoRingCancelRequest(ioRing, file, opToCancel, userData)
// ioRing : HIORING -> "pointer"
// file : IORING_HANDLE_REF -> "buffer"
// opToCancel : UINT_PTR -> "usize"
// userData : UINT_PTR -> "usize"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t BuildIoRingCancelRequest(
    void* ioRing,
    IORING_HANDLE_REF file,
    size_t opToCancel,
    size_t userData);
C, "api-ms-win-core-ioring-l1-1-0.dll");
// $ffi->BuildIoRingCancelRequest(ioRing, file, opToCancel, userData);
// ioRing : HIORING
// file : IORING_HANDLE_REF
// opToCancel : UINT_PTR
// 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 BuildIoRingCancelRequest(
        Pointer ioRing,   // HIORING
        IORING_HANDLE_REF /* extends Structure (by value) */ file,   // IORING_HANDLE_REF
        long opToCancel,   // UINT_PTR
        long userData   // UINT_PTR
    );
}
@[Link("api-ms-win-core-ioring-l1-1-0")]
lib Libapi-ms-win-core-ioring-l1-1-0
  fun BuildIoRingCancelRequest = BuildIoRingCancelRequest(
    ioRing : Void*,   # HIORING
    file : IORING_HANDLE_REF,   # IORING_HANDLE_REF
    opToCancel : LibC::SizeT,   # UINT_PTR
    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 BuildIoRingCancelRequestNative = Int32 Function(Pointer<Void>, IORING_HANDLE_REF, UintPtr, UintPtr);
typedef BuildIoRingCancelRequestDart = int Function(Pointer<Void>, int, int, int);
final BuildIoRingCancelRequest = DynamicLibrary.open('api-ms-win-core-ioring-l1-1-0.dll')
    .lookupFunction<BuildIoRingCancelRequestNative, BuildIoRingCancelRequestDart>('BuildIoRingCancelRequest');
// ioRing : HIORING -> Pointer<Void>
// file : IORING_HANDLE_REF -> IORING_HANDLE_REF
// opToCancel : UINT_PTR -> UintPtr
// userData : UINT_PTR -> UintPtr
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function BuildIoRingCancelRequest(
  ioRing: THandle;   // HIORING
  file: IORING_HANDLE_REF;   // IORING_HANDLE_REF
  opToCancel: NativeUInt;   // UINT_PTR
  userData: NativeUInt   // UINT_PTR
): Integer; stdcall;
  external 'api-ms-win-core-ioring-l1-1-0.dll' name 'BuildIoRingCancelRequest';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "BuildIoRingCancelRequest"
  c_BuildIoRingCancelRequest :: Ptr () -> IORING_HANDLE_REF -> CUIntPtr -> CUIntPtr -> IO Int32
-- ioRing : HIORING -> Ptr ()
-- file : IORING_HANDLE_REF -> IORING_HANDLE_REF
-- opToCancel : UINT_PTR -> CUIntPtr
-- userData : UINT_PTR -> CUIntPtr
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。
open Ctypes
open Foreign

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

関連項目

使用する型