mmioAdvance

関数

MMIOファイルのI/Oバッファを進める。

DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD mmioAdvance(
    HMMIO hmmio,
    MMIOINFO* pmmioinfo,   // optional
    DWORD fuAdvance
);

パラメーター

名前

型

方向

説明

hmmio

HMMIO

mmioOpen 関数を使用して開いたファイルのファイルハンドル。

pmmioinfo

MMIOINFO*

inoptional

mmioGetInfo 関数を使用して取得した MMIOINFO 構造体へのポインター。この構造体は現在のファイル情報を設定するために使用され、バッファが進められた後に更新されます。このパラメーターは省略可能です。

fuAdvance

DWORD

操作のフラグ。次のいずれかを指定できます。

値	意味
MMIO_READ	バッファがファイルから読み込まれます。
MMIO_WRITE	バッファがファイルに書き込まれます。

戻り値の型: DWORD

公式ドキュメント

mmioAdvance 関数は、mmioGetInfo 関数によって直接 I/O バッファアクセス用に設定されたファイルの I/O バッファを進めます。

戻り値

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

戻り値	説明
MMIOERR_CANNOTEXPAND	指定されたメモリファイルを拡張できません。おそらく、mmioOpen 関数の最初の呼び出しで MMIOINFO 構造体の adwInfo メンバーがゼロに設定されていたためです。
MMIOERR_CANNOTREAD	バッファの再充填中にエラーが発生しました。
MMIOERR_CANNOTWRITE	バッファの内容をディスクに書き込めませんでした。
MMIOERR_OUTOFMEMORY	メモリファイルをさらに書き込むために拡張するメモリが不足していました。
MMIOERR_UNBUFFERED	指定されたファイルはバッファリング I/O 用に開かれていません。

解説(Remarks)

ファイルが読み取り用に開かれている場合、I/O バッファはディスクから読み込まれます。ファイルが書き込み用に開かれており、MMIOINFO 構造体の dwFlags メンバーに MMIO_DIRTY フラグが設定されている場合、バッファはディスクに書き込まれます。MMIOINFO 構造体の pchNext、pchEndRead、pchEndWrite の各メンバーは、I/O バッファの新しい状態を反映するように更新されます。

指定されたファイルが書き込み用、または読み取りと書き込みの両方用に開かれている場合、次のバッファが読み込まれる前に I/O バッファがディスクにフラッシュされます。ディスクが満杯のために I/O バッファをディスクに書き込めない場合、mmioAdvance は MMIOERR_CANNOTWRITE を返します。

指定されたファイルが書き込み専用で開かれている場合は、MMIO_WRITE フラグを指定する必要があります。

I/O バッファに書き込んだ場合は、mmioAdvance を呼び出す前に MMIOINFO 構造体の dwFlags メンバーに MMIO_DIRTY フラグを設定する必要があります。設定しないと、バッファはディスクに書き込まれません。

ファイルの終端に達した場合でも、これ以上データを読み取れないにもかかわらず mmioAdvance は正常に返ります。ファイルの終端を確認するには、mmioAdvance の呼び出し後に MMIOINFO 構造体の pchNext メンバーと pchEndRead メンバーが等しいかどうかを確認してください。

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

各言語での呼び出し定義

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

DWORD mmioAdvance(
    HMMIO hmmio,
    MMIOINFO* pmmioinfo,   // optional
    DWORD fuAdvance
);

[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint mmioAdvance(
    IntPtr hmmio,   // HMMIO
    IntPtr pmmioinfo,   // MMIOINFO* optional
    uint fuAdvance   // DWORD
);

<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function mmioAdvance(
    hmmio As IntPtr,   ' HMMIO
    pmmioinfo As IntPtr,   ' MMIOINFO* optional
    fuAdvance As UInteger   ' DWORD
) As UInteger
End Function

' hmmio : HMMIO
' pmmioinfo : MMIOINFO* optional
' fuAdvance : DWORD
Declare PtrSafe Function mmioAdvance Lib "winmm" ( _
    ByVal hmmio As LongPtr, _
    ByVal pmmioinfo As LongPtr, _
    ByVal fuAdvance As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

mmioAdvance = ctypes.windll.winmm.mmioAdvance
mmioAdvance.restype = wintypes.DWORD
mmioAdvance.argtypes = [
    wintypes.HANDLE,  # hmmio : HMMIO
    ctypes.c_void_p,  # pmmioinfo : MMIOINFO* optional
    wintypes.DWORD,  # fuAdvance : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mmioAdvance = Fiddle::Function.new(
  lib['mmioAdvance'],
  [
    Fiddle::TYPE_VOIDP,  # hmmio : HMMIO
    Fiddle::TYPE_VOIDP,  # pmmioinfo : MMIOINFO* optional
    -Fiddle::TYPE_INT,  # fuAdvance : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn mmioAdvance(
        hmmio: *mut core::ffi::c_void,  // HMMIO
        pmmioinfo: *mut MMIOINFO,  // MMIOINFO* optional
        fuAdvance: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll")]
public static extern uint mmioAdvance(IntPtr hmmio, IntPtr pmmioinfo, uint fuAdvance);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mmioAdvance' -Namespace Win32 -PassThru
# $api::mmioAdvance(hmmio, pmmioinfo, fuAdvance)

#uselib "WINMM.dll"
#func global mmioAdvance "mmioAdvance" sptr, sptr, sptr
; mmioAdvance hmmio, varptr(pmmioinfo), fuAdvance   ; 戻り値は stat
; hmmio : HMMIO -> "sptr"
; pmmioinfo : MMIOINFO* optional -> "sptr"
; fuAdvance : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global mmioAdvance "mmioAdvance" sptr, var, int
; res = mmioAdvance(hmmio, pmmioinfo, fuAdvance)
; hmmio : HMMIO -> "sptr"
; pmmioinfo : MMIOINFO* optional -> "var"
; fuAdvance : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global mmioAdvance "mmioAdvance" sptr, sptr, int
; res = mmioAdvance(hmmio, varptr(pmmioinfo), fuAdvance)
; hmmio : HMMIO -> "sptr"
; pmmioinfo : MMIOINFO* optional -> "sptr"
; fuAdvance : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。