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

FlushFileBuffers

関数
ファイルのバッファをディスクに書き込んで反映する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

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

BOOL FlushFileBuffers(
    HANDLE hFile
);

パラメーター

名前方向説明
hFileHANDLEin

開いているファイルへのハンドル。

ファイルハンドルには GENERIC_WRITE アクセス権が必要です。詳細については、 File Security and Access Rights を参照してください。

hFile が通信デバイスへのハンドルである場合、この関数は送信バッファのみをフラッシュします。

hFile が名前付きパイプのサーバー側へのハンドルである場合、この関数はクライアントがパイプからバッファされたすべてのデータを読み取るまで処理を返しません。

戻り値の型: BOOL

公式ドキュメント

指定されたファイルのバッファをフラッシュし、バッファされているすべてのデータをファイルに書き込みます。

戻り値

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

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

hFile がコンソール出力へのハンドルである場合、関数は失敗します。これはコンソール出力がバッファされないためです。関数は FALSE を返し、GetLastErrorERROR_INVALID_HANDLE を返します。

解説(Remarks)

通常、 WriteFile および WriteFileEx 関数は、オペレーティングシステムが定期的にディスクや通信パイプに書き込む内部バッファにデータを書き込みます。 FlushFileBuffers 関数は、指定されたファイルについてバッファされているすべての情報をデバイスまたはパイプに書き込みます。

システム内のディスクキャッシュの相互作用により、多数の書き込みが個別に実行される場合、ディスクドライブデバイスへの各書き込みの後で FlushFileBuffers 関数を使用すると非効率的になることがあります。アプリケーションがディスクへの複数の書き込みを行いつつ、重要なデータが永続メディアに確実に書き込まれることを保証する必要がある場合は、頻繁に FlushFileBuffers を呼び出す代わりにバッファなし I/O を使用してください。バッファなし I/O でファイルを開くには、FILE_FLAG_NO_BUFFERING および FILE_FLAG_WRITE_THROUGH フラグを指定して CreateFile 関数を呼び出します。これにより、ファイルの内容がキャッシュされなくなり、各書き込みでメタデータがディスクにフラッシュされます。詳細については、CreateFile を参照してください。

ボリューム上のすべての開いているファイルをフラッシュするには、ボリュームへのハンドルを指定して FlushFileBuffers を呼び出します。呼び出し元には管理者特権が必要です。詳細については、 Running with Special Privileges を参照してください。

CreateFile でボリュームを開く場合、lpFileName 文字列は次の形式にする必要があります: \\.\x: または \\?\Volume{GUID}。ボリューム名の末尾にバックスラッシュを使用しないでください。これはドライブのルートディレクトリを示すためです。

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) はい

例については、 Multithreaded Pipe Server を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

FlushFileBuffers = ctypes.windll.kernel32.FlushFileBuffers
FlushFileBuffers.restype = wintypes.BOOL
FlushFileBuffers.argtypes = [
    wintypes.HANDLE,  # hFile : HANDLE
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
FlushFileBuffers = Fiddle::Function.new(
  lib['FlushFileBuffers'],
  [
    Fiddle::TYPE_VOIDP,  # hFile : HANDLE
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn FlushFileBuffers(
        hFile: *mut core::ffi::c_void  // HANDLE
    ) -> 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 FlushFileBuffers(IntPtr hFile);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_FlushFileBuffers' -Namespace Win32 -PassThru
# $api::FlushFileBuffers(hFile)
#uselib "KERNEL32.dll"
#func global FlushFileBuffers "FlushFileBuffers" sptr
; FlushFileBuffers hFile   ; 戻り値は stat
; hFile : HANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global FlushFileBuffers "FlushFileBuffers" sptr
; res = FlushFileBuffers(hFile)
; hFile : HANDLE -> "sptr"
; BOOL FlushFileBuffers(HANDLE hFile)
#uselib "KERNEL32.dll"
#cfunc global FlushFileBuffers "FlushFileBuffers" intptr
; res = FlushFileBuffers(hFile)
; hFile : HANDLE -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procFlushFileBuffers = kernel32.NewProc("FlushFileBuffers")
)

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

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

typedef FlushFileBuffersNative = Int32 Function(Pointer<Void>);
typedef FlushFileBuffersDart = int Function(Pointer<Void>);
final FlushFileBuffers = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<FlushFileBuffersNative, FlushFileBuffersDart>('FlushFileBuffers');
// hFile : HANDLE -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function FlushFileBuffers(
  hFile: THandle   // HANDLE
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'FlushFileBuffers';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let flushfilebuffers =
  foreign "FlushFileBuffers"
    ((ptr void) @-> returning int32_t)
(* hFile : HANDLE -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("FlushFileBuffers" flush-file-buffers :convention :stdcall) :int32
  (h-file :pointer))   ; HANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $FlushFileBuffers = Win32::API::More->new('KERNEL32',
    'BOOL FlushFileBuffers(HANDLE hFile)');
# my $ret = $FlushFileBuffers->Call($hFile);
# hFile : HANDLE -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目