Win32 API 日本語リファレンス
ホームMedia.Multimedia › mmioFlush

mmioFlush

関数
MMIOファイルのI/Oバッファをディスクに書き出す。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD mmioFlush(
    HMMIO hmmio,
    DWORD fuFlush
);

パラメーター

名前方向説明
hmmioHMMIOinmmioOpen 関数を使用して開いたファイルのファイルハンドル。
fuFlushDWORDin

フラッシュの実行方法を決定するフラグ。0 または次の値を指定できます。

説明
MMIO_EMPTYBUF バッファをディスクへ書き込んだ後、バッファを空にします。

戻り値の型: DWORD

公式ドキュメント

mmioFlush 関数は、ファイルの I/O バッファに書き込みがあった場合に、そのバッファをディスクへ書き出します。

戻り値

成功した場合は 0 を返し、それ以外の場合はエラーを返します。考えられるエラー値には次のものがあります。

戻り値 説明
MMIOERR_CANNOTWRITE
バッファの内容をディスクへ書き込めませんでした。

解説(Remarks)

mmioClose 関数でファイルを閉じると、そのバッファは自動的にフラッシュされます。

バッファを書き込むためのディスク領域が不足している場合、直前の mmioWrite 関数の呼び出しが成功していたとしても、mmioFlush は失敗します。

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

各言語での呼び出し定義

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

DWORD mmioFlush(
    HMMIO hmmio,
    DWORD fuFlush
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint mmioFlush(
    IntPtr hmmio,   // HMMIO
    uint fuFlush   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function mmioFlush(
    hmmio As IntPtr,   ' HMMIO
    fuFlush As UInteger   ' DWORD
) As UInteger
End Function
' hmmio : HMMIO
' fuFlush : DWORD
Declare PtrSafe Function mmioFlush Lib "winmm" ( _
    ByVal hmmio As LongPtr, _
    ByVal fuFlush As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

mmioFlush = ctypes.windll.winmm.mmioFlush
mmioFlush.restype = wintypes.DWORD
mmioFlush.argtypes = [
    wintypes.HANDLE,  # hmmio : HMMIO
    wintypes.DWORD,  # fuFlush : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mmioFlush = Fiddle::Function.new(
  lib['mmioFlush'],
  [
    Fiddle::TYPE_VOIDP,  # hmmio : HMMIO
    -Fiddle::TYPE_INT,  # fuFlush : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn mmioFlush(
        hmmio: *mut core::ffi::c_void,  // HMMIO
        fuFlush: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint mmioFlush(IntPtr hmmio, uint fuFlush);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mmioFlush' -Namespace Win32 -PassThru
# $api::mmioFlush(hmmio, fuFlush)
#uselib "WINMM.dll"
#func global mmioFlush "mmioFlush" sptr, sptr
; mmioFlush hmmio, fuFlush   ; 戻り値は stat
; hmmio : HMMIO -> "sptr"
; fuFlush : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global mmioFlush "mmioFlush" sptr, int
; res = mmioFlush(hmmio, fuFlush)
; hmmio : HMMIO -> "sptr"
; fuFlush : DWORD -> "int"
; DWORD mmioFlush(HMMIO hmmio, DWORD fuFlush)
#uselib "WINMM.dll"
#cfunc global mmioFlush "mmioFlush" intptr, int
; res = mmioFlush(hmmio, fuFlush)
; hmmio : HMMIO -> "intptr"
; fuFlush : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmmioFlush = winmm.NewProc("mmioFlush")
)

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

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

typedef mmioFlushNative = Uint32 Function(Pointer<Void>, Uint32);
typedef mmioFlushDart = int Function(Pointer<Void>, int);
final mmioFlush = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<mmioFlushNative, mmioFlushDart>('mmioFlush');
// hmmio : HMMIO -> Pointer<Void>
// fuFlush : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function mmioFlush(
  hmmio: THandle;   // HMMIO
  fuFlush: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'mmioFlush';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "mmioFlush"
  c_mmioFlush :: Ptr () -> Word32 -> IO Word32
-- hmmio : HMMIO -> Ptr ()
-- fuFlush : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let mmioflush =
  foreign "mmioFlush"
    ((ptr void) @-> uint32_t @-> returning uint32_t)
(* hmmio : HMMIO -> (ptr void) *)
(* fuFlush : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

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