Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
hFileHANDLEin
aSegmentArrayFILE_SEGMENT_ELEMENT*in
nNumberOfBytesToWriteDWORDin
lpReservedDWORD*optional
lpOverlappedOVERLAPPED*inout

戻り値の型: BOOL

各言語での呼び出し定義

// 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 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 方式にも切替可。
出力引数:
; BOOL WriteFileGather(HANDLE hFile, FILE_SEGMENT_ELEMENT* aSegmentArray, DWORD nNumberOfBytesToWrite, DWORD* lpReserved, OVERLAPPED* lpOverlapped)
#uselib "KERNEL32.dll"
#cfunc global WriteFileGather "WriteFileGather" intptr, var, int, var, var
; res = WriteFileGather(hFile, aSegmentArray, nNumberOfBytesToWrite, lpReserved, lpOverlapped)
; hFile : HANDLE -> "intptr"
; aSegmentArray : FILE_SEGMENT_ELEMENT* -> "var"
; nNumberOfBytesToWrite : DWORD -> "int"
; lpReserved : DWORD* optional -> "var"
; lpOverlapped : OVERLAPPED* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procWriteFileGather = kernel32.NewProc("WriteFileGather")
)

// hFile (HANDLE), aSegmentArray (FILE_SEGMENT_ELEMENT*), nNumberOfBytesToWrite (DWORD), lpReserved (DWORD* optional), lpOverlapped (OVERLAPPED* in/out)
r1, _, err := procWriteFileGather.Call(
	uintptr(hFile),
	uintptr(aSegmentArray),
	uintptr(nNumberOfBytesToWrite),
	uintptr(lpReserved),
	uintptr(lpOverlapped),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function WriteFileGather(
  hFile: THandle;   // HANDLE
  aSegmentArray: Pointer;   // FILE_SEGMENT_ELEMENT*
  nNumberOfBytesToWrite: DWORD;   // DWORD
  lpReserved: Pointer;   // DWORD* optional
  lpOverlapped: Pointer   // OVERLAPPED* in/out
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'WriteFileGather';
result := DllCall("KERNEL32\WriteFileGather"
    , "Ptr", hFile   ; HANDLE
    , "Ptr", aSegmentArray   ; FILE_SEGMENT_ELEMENT*
    , "UInt", nNumberOfBytesToWrite   ; DWORD
    , "Ptr", lpReserved   ; DWORD* optional
    , "Ptr", lpOverlapped   ; OVERLAPPED* in/out
    , "Int")   ; return: BOOL
●WriteFileGather(hFile, aSegmentArray, nNumberOfBytesToWrite, lpReserved, lpOverlapped) = DLL("KERNEL32.dll", "bool WriteFileGather(void*, void*, dword, void*, void*)")
# 呼び出し: WriteFileGather(hFile, aSegmentArray, nNumberOfBytesToWrite, lpReserved, lpOverlapped)
# hFile : HANDLE -> "void*"
# aSegmentArray : FILE_SEGMENT_ELEMENT* -> "void*"
# nNumberOfBytesToWrite : DWORD -> "dword"
# lpReserved : DWORD* optional -> "void*"
# lpOverlapped : OVERLAPPED* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。