ホーム › Storage.FileSystem › ReadFileScatter

ReadFileScatter

関数

ファイルから複数のバッファへ分散して読み込む。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL ReadFileScatter(
    HANDLE hFile,
    FILE_SEGMENT_ELEMENT* aSegmentArray,
    DWORD nNumberOfBytesToRead,
    DWORD* lpReserved,   // optional
    OVERLAPPED* lpOverlapped
);

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	読み取り対象のファイルへのハンドルです。このファイルハンドルは、GENERIC_READ アクセス権、および FILE_FLAG_OVERLAPPED フラグと FILE_FLAG_NO_BUFFERING フラグを指定して作成する必要があります。詳細については、File Security and Access Rights を参照してください。
aSegmentArray	FILE_SEGMENT_ELEMENT*	in	データを受け取る FILE_SEGMENT_ELEMENT 構造体のバッファー配列へのポインターです。この共用体の説明については、解説を参照してください。各要素はデータの 1 ページを表します。メモシステムページのサイズを取得するには、GetSystemInfo を使用してください。この配列には、nNumberOfBytesToRead バイトのデータを表すのに十分な数の要素が含まれている必要があります。たとえば、読み取るデータが 40 KB でページサイズが 4 KB の場合、配列には 10 個の要素が必要です。各バッファーは少なくともシステムメモリページのサイズ以上であり、システムメモリページサイズの境界に整列している必要があります。システムは各バッファーに 1 システムメモリページ分のデータを読み込みます。この関数はデータを順番にバッファーへ格納します。たとえば、最初のバッファーにデータを格納し、次に 2 番目のバッファーへ、という順で、各バッファーが満たされてすべてのデータが格納されるか、nNumberOfBytesToRead バイトが読み取られるまで続きます。
nNumberOfBytesToRead	DWORD	in	ファイルから読み取るバイトの総数です。aSegmentArray の各要素は、この総数のうち 1 ページ分のチャンクを保持します。ファイルは FILE_FLAG_NO_BUFFERING で開く必要があるため、このバイト数は、ファイルが置かれているファイルシステムのセクターサイズの倍数でなければなりません。
lpReserved	DWORD*	optional	このパラメーターは将来の使用のために予約されており、NULL を指定する必要があります。
lpOverlapped	OVERLAPPED*	inout	OVERLAPPED データ構造体へのポインターです。 ReadFileScatter 関数には有効な OVERLAPPED 構造体が必要です。lpOverlapped パラメーターを NULL にすることはできません。 ReadFileScatter 関数は、OVERLAPPED 構造体の Offset メンバーと OffsetHigh メンバーで指定された位置からファイルのデータの読み取りを開始します。 ReadFileScatter 関数は、読み取り操作が完了する前に戻ることがあります。その場合、ReadFileScatter 関数は値 0 (ゼロ) を返し、GetLastError 関数は値 ERROR_IO_PENDING を返します。この ReadFileScatter の非同期動作により、読み取り操作の完了中も呼び出し元プロセスは処理を継続できます。読み取り操作の完了に関する情報を取得するには、GetOverlappedResult、HasOverlappedIoCompleted、または GetQueuedCompletionStatus 関数を呼び出します。詳細については、Synchronous and Asynchronous I/O を参照してください。

戻り値の型: BOOL

公式ドキュメント

ファイルからデータを読み取り、複数のバッファーの配列に格納します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗すると、戻り値は 0 (ゼロ) になります。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

ReadFileScatter がファイルの末尾 (EOF) を越えて読み取ろうとした場合、その操作に対する GetOverlappedResult の呼び出しは FALSE を返し、GetLastError は ERROR_HANDLE_EOF を返します。

読み取り操作が完了する前に関数が戻った場合、関数は 0 (ゼロ) を返し、GetLastError は ERROR_IO_PENDING を返します。

解説(Remarks)

この関数は、Itanium ベースのシステム上の WOW64 における 32 ビットアプリケーションではサポートされていません。

FILE_SEGMENT_ELEMENT 構造体は次のように定義されています。

typedef union _FILE_SEGMENT_ELEMENT {
    PVOID64 Buffer;
    ULONGLONG Alignment;
}FILE_SEGMENT_ELEMENT, *PFILE_SEGMENT_ELEMENT;

コードを 32 ビットとしてコンパイルした場合、Buffer メンバーにポインターを代入すると値が符号拡張されます。これにより、4-Gigabyte Tuning が構成されたシステム上、または 64 ビット Windows の WOW64 上で実行されている large-address aware アプリケーションが破綻する可能性があります。そのため、Buffer にポインターを代入する際には PtrToPtr64 マクロを使用してください。

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 ReadFileScatter(
    HANDLE hFile,
    FILE_SEGMENT_ELEMENT* aSegmentArray,
    DWORD nNumberOfBytesToRead,
    DWORD* lpReserved,   // optional
    OVERLAPPED* lpOverlapped
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool ReadFileScatter(
    IntPtr hFile,   // HANDLE
    IntPtr aSegmentArray,   // FILE_SEGMENT_ELEMENT*
    uint nNumberOfBytesToRead,   // DWORD
    IntPtr lpReserved,   // DWORD* optional
    IntPtr lpOverlapped   // OVERLAPPED* in/out
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function ReadFileScatter(
    hFile As IntPtr,   ' HANDLE
    aSegmentArray As IntPtr,   ' FILE_SEGMENT_ELEMENT*
    nNumberOfBytesToRead As UInteger,   ' DWORD
    lpReserved As IntPtr,   ' DWORD* optional
    lpOverlapped As IntPtr   ' OVERLAPPED* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hFile : HANDLE
' aSegmentArray : FILE_SEGMENT_ELEMENT*
' nNumberOfBytesToRead : DWORD
' lpReserved : DWORD* optional
' lpOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function ReadFileScatter Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal aSegmentArray As LongPtr, _
    ByVal nNumberOfBytesToRead As Long, _
    ByVal lpReserved As LongPtr, _
    ByVal lpOverlapped As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

ReadFileScatter = ctypes.windll.kernel32.ReadFileScatter
ReadFileScatter.restype = wintypes.BOOL
ReadFileScatter.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # aSegmentArray : FILE_SEGMENT_ELEMENT*
    wintypes.DWORD,  # nNumberOfBytesToRead : DWORD
    ctypes.POINTER(wintypes.DWORD),  # lpReserved : DWORD* optional
    ctypes.c_void_p,  # lpOverlapped : OVERLAPPED* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
ReadFileScatter = Fiddle::Function.new(
  lib['ReadFileScatter'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # aSegmentArray : FILE_SEGMENT_ELEMENT*
    -Fiddle::TYPE_INT,  # nNumberOfBytesToRead : DWORD
    Fiddle::TYPE_VOIDP,  # lpReserved : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn ReadFileScatter(
        hFile: *mut core::ffi::c_void,  // HANDLE
        aSegmentArray: *mut FILE_SEGMENT_ELEMENT,  // FILE_SEGMENT_ELEMENT*
        nNumberOfBytesToRead: u32,  // DWORD
        lpReserved: *mut u32,  // DWORD* optional
        lpOverlapped: *mut OVERLAPPED  // OVERLAPPED* in/out
    ) -> 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 ReadFileScatter(IntPtr hFile, IntPtr aSegmentArray, uint nNumberOfBytesToRead, IntPtr lpReserved, IntPtr lpOverlapped);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_ReadFileScatter' -Namespace Win32 -PassThru
# $api::ReadFileScatter(hFile, aSegmentArray, nNumberOfBytesToRead, lpReserved, lpOverlapped)

#uselib "KERNEL32.dll"
#func global ReadFileScatter "ReadFileScatter" sptr, sptr, sptr, sptr, sptr
; ReadFileScatter hFile, varptr(aSegmentArray), nNumberOfBytesToRead, varptr(lpReserved), varptr(lpOverlapped)   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; aSegmentArray : FILE_SEGMENT_ELEMENT* -> "sptr"
; nNumberOfBytesToRead : DWORD -> "sptr"
; lpReserved : DWORD* optional -> "sptr"
; lpOverlapped : OVERLAPPED* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global ReadFileScatter "ReadFileScatter" sptr, var, int, var, var
; res = ReadFileScatter(hFile, aSegmentArray, nNumberOfBytesToRead, lpReserved, lpOverlapped)
; hFile : HANDLE -> "sptr"
; aSegmentArray : FILE_SEGMENT_ELEMENT* -> "var"
; nNumberOfBytesToRead : DWORD -> "int"
; lpReserved : DWORD* optional -> "var"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global ReadFileScatter "ReadFileScatter" sptr, sptr, int, sptr, sptr
; res = ReadFileScatter(hFile, varptr(aSegmentArray), nNumberOfBytesToRead, varptr(lpReserved), varptr(lpOverlapped))
; hFile : HANDLE -> "sptr"
; aSegmentArray : FILE_SEGMENT_ELEMENT* -> "sptr"
; nNumberOfBytesToRead : DWORD -> "int"
; lpReserved : DWORD* optional -> "sptr"
; lpOverlapped : OVERLAPPED* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。