ホーム › Storage.FileSystem › WriteFileGather

WriteFileGather

関数

複数のバッファからファイルへまとめて書き込む。

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

シグネチャ

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

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

パラメーター

名前	型	方向	説明
hFile	HANDLE	in	ファイルへのハンドル。このファイルハンドルは、GENERIC_WRITE アクセス権、ならびに FILE_FLAG_OVERLAPPED および FILE_FLAG_NO_BUFFERING フラグを指定して作成されている必要があります。詳細については、File Security and Access Rights を参照してください。
aSegmentArray	FILE_SEGMENT_ELEMENT*	in	データを格納する FILE_SEGMENT_ELEMENT 構造体バッファの配列へのポインター。この共用体の説明については、「解説」を参照してください。各要素は 1 ページ分のデータを表します。メモシステムページのサイズを取得するには、GetSystemInfo 関数を使用してください。この配列には、nNumberOfBytesToWrite バイトのデータを表すのに十分な数の要素が含まれている必要があります。たとえば、書き込むデータが 40 KB でページサイズが 4 KB の場合、配列には 10 個の要素が必要です。各バッファは、少なくともシステムメモリページ 1 ページ分のサイズを持ち、システムメモリページサイズ境界に整列している必要があります。システムは各バッファからシステムメモリ 1 ページ分のデータを書き込みます。この関数は、バッファからデータを順番に収集します。たとえば、最初のバッファ、次に 2 番目のバッファというように、nNumberOfBytesToWrite バイトが書き込まれるまで、順にファイルへデータを書き込みます。この関数は非同期で動作するため、非同期書き込みが行われている間、このパラメーターが常に有効なメモリを参照し続けるように注意を払う必要があります。たとえば、よくあるプログラミング上の誤りとして、ローカルスタック上の領域を使用し、その後スコープ外で実行が継続されてしまうケースがあります。
nNumberOfBytesToWrite	DWORD	in	書き込むバイトの総数。aSegmentArray の各要素には、この総数のうち 1 ページ分のチャンクが含まれます。ファイルは FILE_FLAG_NO_BUFFERING を指定して開かれている必要があるため、バイト数はファイルが存在するファイルシステムのセクターサイズの倍数でなければなりません。 nNumberOfBytesToWrite が 0 の場合、関数は NULL 書き込み操作を実行します。NULL 書き込み操作の動作は、基盤となるファイルシステムによって異なります。nNumberOfBytesToWrite が 0 でなく、書き込みのオフセットと長さによってデータが現在のファイルの末尾を超えて配置される場合、WriteFileGather 関数はファイルを拡張します。
lpReserved	DWORD*	optional	このパラメーターは将来の使用のために予約されており、NULL でなければなりません。
lpOverlapped	OVERLAPPED*	inout	OVERLAPPED データ構造体へのポインター。 WriteFileGather 関数には、有効な OVERLAPPED 構造体が必要です。lpOverlapped パラメーターを NULL にすることはできません。 WriteFileGather 関数は、OVERLAPPED 構造体の Offset および OffsetHigh メンバーで指定された位置からファイルへのデータ書き込みを開始します。 WriteFileGather 関数は、書き込み操作が完了する前に戻ることがあります。その場合、WriteFileGather 関数は 0 を返し、GetLastError 関数は ERROR_IO_PENDING を返します。この WriteFileGather 関数の非同期動作により、書き込み操作の完了中も呼び出し元のプロセスは処理を続行できます。書き込み操作の完了に関する情報を取得するには、GetOverlappedResult、HasOverlappedIoCompleted、または GetQueuedCompletionStatus 関数を呼び出すことができます。詳細については、Synchronous and Asynchronous I/O を参照してください。

戻り値の型: BOOL

公式ドキュメント

複数のバッファの配列からデータを取得し、そのデータをファイルに書き込みます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、GetLastError 関数を呼び出してください。

書き込み操作が完了する前に関数が戻った場合、関数は 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 で動作するラージアドレス対応アプリケーションが正しく動作しなくなる可能性があります。したがって、Buffer にポインターを代入する際には PtrToPtr64 マクロを使用してください。

hFile で指定されたファイルの一部が別のプロセスによってロックされており、書き込み操作がそのロックされた部分と重なる場合、WriteFileGather 関数は失敗します。

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

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

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function WriteFileGather(
    hFile As IntPtr,   ' HANDLE
    aSegmentArray As IntPtr,   ' FILE_SEGMENT_ELEMENT*
    nNumberOfBytesToWrite 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*
' nNumberOfBytesToWrite : DWORD
' lpReserved : DWORD* optional
' lpOverlapped : OVERLAPPED* in/out
Declare PtrSafe Function WriteFileGather Lib "kernel32" ( _
    ByVal hFile As LongPtr, _
    ByVal aSegmentArray As LongPtr, _
    ByVal nNumberOfBytesToWrite 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

WriteFileGather = ctypes.windll.kernel32.WriteFileGather
WriteFileGather.restype = wintypes.BOOL
WriteFileGather.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
    ctypes.c_void_p,  # aSegmentArray : FILE_SEGMENT_ELEMENT*
    wintypes.DWORD,  # nNumberOfBytesToWrite : 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')
WriteFileGather = Fiddle::Function.new(
  lib['WriteFileGather'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
    Fiddle::TYPE_VOIDP,  # aSegmentArray : FILE_SEGMENT_ELEMENT*
    -Fiddle::TYPE_INT,  # nNumberOfBytesToWrite : DWORD
    Fiddle::TYPE_VOIDP,  # lpReserved : DWORD* optional
    Fiddle::TYPE_VOIDP,  # lpOverlapped : OVERLAPPED* in/out
  ],
  Fiddle::TYPE_INT)

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

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

出力引数:

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