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

SetFileIoOverlappedRange

関数
非同期I/O用にロックするメモリ範囲を指定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

BOOL SetFileIoOverlappedRange(
    HANDLE FileHandle,
    BYTE* OverlappedRangeStart,
    DWORD Length
);

パラメーター

名前方向説明
FileHandleHANDLEin

ファイルへのハンドル。

このファイルハンドルは、FILE_READ_ATTRIBUTES アクセス権で開かれている必要があります。

OverlappedRangeStartBYTE*in範囲の開始アドレス。
LengthDWORDin範囲の長さ(バイト単位)。

戻り値の型: BOOL

公式ドキュメント

仮想アドレス範囲を、指定したファイルハンドルに関連付けます。

戻り値

成功した場合は 0 以外の値を、それ以外の場合は 0 を返します。

拡張エラー情報を取得するには、 GetLastError を呼び出します。

解説(Remarks)

SetFileIoOverlappedRange は、多数の非同期かつバッファリングされない I/O を発行し、定義済みの範囲の overlapped 構造体を使用するアプリケーションのパフォーマンスを向上させるために使用できます。この構造体の範囲はメモリ内にロックされるため、I/O 要求の結果で overlapped 構造体を更新する際に、カーネルは特定のロックの取得を回避できます。

SetFileIoOverlappedRange は、呼び出し元が SeLockMemoryPrivilege アクセス特権を持っていることを必要とします。

この関数は、バッファリングされた I/O および同期 I/O には影響しません。

Windows 8 および Windows Server 2012 では、この関数は次のテクノロジでサポートされています。

テクノロジ サポート
Server Message Block (SMB) 3.0 プロトコル はい
SMB 3.0 Transparent Failover (TFO) はい
SMB 3.0 with Scale-out File Shares (SO) はい
Cluster Shared Volume File System (CsvFS) はい
Resilient File System (ReFS) はい
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

BOOL SetFileIoOverlappedRange(
    HANDLE FileHandle,
    BYTE* OverlappedRangeStart,
    DWORD Length
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetFileIoOverlappedRange(
    IntPtr FileHandle,   // HANDLE
    IntPtr OverlappedRangeStart,   // BYTE*
    uint Length   // DWORD
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetFileIoOverlappedRange(
    FileHandle As IntPtr,   ' HANDLE
    OverlappedRangeStart As IntPtr,   ' BYTE*
    Length As UInteger   ' DWORD
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' FileHandle : HANDLE
' OverlappedRangeStart : BYTE*
' Length : DWORD
Declare PtrSafe Function SetFileIoOverlappedRange Lib "kernel32" ( _
    ByVal FileHandle As LongPtr, _
    ByVal OverlappedRangeStart As LongPtr, _
    ByVal Length As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetFileIoOverlappedRange = ctypes.windll.kernel32.SetFileIoOverlappedRange
SetFileIoOverlappedRange.restype = wintypes.BOOL
SetFileIoOverlappedRange.argtypes = [
    wintypes.HANDLE,  # FileHandle : HANDLE
    ctypes.POINTER(ctypes.c_ubyte),  # OverlappedRangeStart : BYTE*
    wintypes.DWORD,  # Length : DWORD
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetFileIoOverlappedRange = Fiddle::Function.new(
  lib['SetFileIoOverlappedRange'],
  [
    Fiddle::TYPE_VOIDP,  # FileHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # OverlappedRangeStart : BYTE*
    -Fiddle::TYPE_INT,  # Length : DWORD
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetFileIoOverlappedRange(
        FileHandle: *mut core::ffi::c_void,  // HANDLE
        OverlappedRangeStart: *mut u8,  // BYTE*
        Length: u32  // DWORD
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetFileIoOverlappedRange(IntPtr FileHandle, IntPtr OverlappedRangeStart, uint Length);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetFileIoOverlappedRange' -Namespace Win32 -PassThru
# $api::SetFileIoOverlappedRange(FileHandle, OverlappedRangeStart, Length)
#uselib "KERNEL32.dll"
#func global SetFileIoOverlappedRange "SetFileIoOverlappedRange" sptr, sptr, sptr
; SetFileIoOverlappedRange FileHandle, varptr(OverlappedRangeStart), Length   ; 戻り値は stat
; FileHandle : HANDLE -> "sptr"
; OverlappedRangeStart : BYTE* -> "sptr"
; Length : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "KERNEL32.dll"
#cfunc global SetFileIoOverlappedRange "SetFileIoOverlappedRange" sptr, var, int
; res = SetFileIoOverlappedRange(FileHandle, OverlappedRangeStart, Length)
; FileHandle : HANDLE -> "sptr"
; OverlappedRangeStart : BYTE* -> "var"
; Length : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL SetFileIoOverlappedRange(HANDLE FileHandle, BYTE* OverlappedRangeStart, DWORD Length)
#uselib "KERNEL32.dll"
#cfunc global SetFileIoOverlappedRange "SetFileIoOverlappedRange" intptr, var, int
; res = SetFileIoOverlappedRange(FileHandle, OverlappedRangeStart, Length)
; FileHandle : HANDLE -> "intptr"
; OverlappedRangeStart : BYTE* -> "var"
; Length : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetFileIoOverlappedRange = kernel32.NewProc("SetFileIoOverlappedRange")
)

// FileHandle (HANDLE), OverlappedRangeStart (BYTE*), Length (DWORD)
r1, _, err := procSetFileIoOverlappedRange.Call(
	uintptr(FileHandle),
	uintptr(OverlappedRangeStart),
	uintptr(Length),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetFileIoOverlappedRange(
  FileHandle: THandle;   // HANDLE
  OverlappedRangeStart: Pointer;   // BYTE*
  Length: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFileIoOverlappedRange';
result := DllCall("KERNEL32\SetFileIoOverlappedRange"
    , "Ptr", FileHandle   ; HANDLE
    , "Ptr", OverlappedRangeStart   ; BYTE*
    , "UInt", Length   ; DWORD
    , "Int")   ; return: BOOL
●SetFileIoOverlappedRange(FileHandle, OverlappedRangeStart, Length) = DLL("KERNEL32.dll", "bool SetFileIoOverlappedRange(void*, void*, dword)")
# 呼び出し: SetFileIoOverlappedRange(FileHandle, OverlappedRangeStart, Length)
# FileHandle : HANDLE -> "void*"
# OverlappedRangeStart : BYTE* -> "void*"
# Length : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetFileIoOverlappedRangeNative = Int32 Function(Pointer<Void>, Pointer<Uint8>, Uint32);
typedef SetFileIoOverlappedRangeDart = int Function(Pointer<Void>, Pointer<Uint8>, int);
final SetFileIoOverlappedRange = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetFileIoOverlappedRangeNative, SetFileIoOverlappedRangeDart>('SetFileIoOverlappedRange');
// FileHandle : HANDLE -> Pointer<Void>
// OverlappedRangeStart : BYTE* -> Pointer<Uint8>
// Length : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetFileIoOverlappedRange(
  FileHandle: THandle;   // HANDLE
  OverlappedRangeStart: Pointer;   // BYTE*
  Length: DWORD   // DWORD
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetFileIoOverlappedRange';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetFileIoOverlappedRange"
  c_SetFileIoOverlappedRange :: Ptr () -> Ptr Word8 -> Word32 -> IO CInt
-- FileHandle : HANDLE -> Ptr ()
-- OverlappedRangeStart : BYTE* -> Ptr Word8
-- Length : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setfileiooverlappedrange =
  foreign "SetFileIoOverlappedRange"
    ((ptr void) @-> (ptr uint8_t) @-> uint32_t @-> returning int32_t)
(* FileHandle : HANDLE -> (ptr void) *)
(* OverlappedRangeStart : BYTE* -> (ptr uint8_t) *)
(* Length : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetFileIoOverlappedRange" set-file-io-overlapped-range :convention :stdcall) :int32
  (file-handle :pointer)   ; HANDLE
  (overlapped-range-start :pointer)   ; BYTE*
  (length :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetFileIoOverlappedRange = Win32::API::More->new('KERNEL32',
    'BOOL SetFileIoOverlappedRange(HANDLE FileHandle, LPVOID OverlappedRangeStart, DWORD Length)');
# my $ret = $SetFileIoOverlappedRange->Call($FileHandle, $OverlappedRangeStart, $Length);
# FileHandle : HANDLE -> HANDLE
# OverlappedRangeStart : BYTE* -> LPVOID
# Length : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。