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

CloseIoRing

関数
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 CloseIoRing(
    HIORING ioRing
);

パラメーター

名前方向説明
ioRingHIORINGin閉じる HIORING ハンドル。

戻り値の型: HRESULT

公式ドキュメント

CreateIoRing の呼び出しによって以前に開かれた HIORING ハンドルを閉じます。

戻り値

成功した場合は S_OK を返します。

解説(Remarks)

この関数を呼び出すと、I/O リングのために割り当てられたリソースが確実に解放されます。閉じられたハンドルは、関数が戻った後は無効になります。ハンドルを閉じると、キューに登録されているが送信されていない操作は破棄されることに注意してください。ただし、実行中の操作はキャンセルされ ません

CloseIoRing が戻った後も、メモリバッファーへの読み取りや書き込みが発生する可能性があります。保留中の読み取りや書き込みが発生しないようにするには、送信されたすべての操作について、完了が完了キューに現れるまで待機する必要があります。完了を待機する前に、以前に送信した操作をキャンセルすることもできます。複数のキャンセル要求を送信する代わりに、ファイルハンドルと overlapped ポインターに NULL を指定して CancelIoEx を呼び出すことで、ハンドル上のすべての保留中の操作を効果的にキャンセルできます。

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

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

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

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

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

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

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

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