mmioDescend

関数

RIFFファイル内のチャンクへ降りて検索する。

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

シグネチャ

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

DWORD mmioDescend(
    HMMIO hmmio,
    MMCKINFO* pmmcki,
    const MMCKINFO* pmmckiParent,   // optional
    DWORD fuDescend
);

パラメーター

名前

型

方向

説明

hmmio

HMMIO

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

pmmcki

MMCKINFO*

inout

MMCKINFO 構造体を受け取るバッファーへのポインター。

pmmckiParent

MMCKINFO*

inoptional

検索対象のチャンクの親を識別する、省略可能なアプリケーション定義の MMCKINFO 構造体へのポインター。このパラメーターが NULL でない場合、mmioDescend は、それが参照する MMCKINFO 構造体が、親チャンクへ降下するために mmioDescend が呼び出されたときに設定されたものと見なし、親チャンク内のチャンクを検索します。親チャンクを指定しない場合は、このパラメーターを NULL に設定します。

fuDescend

DWORD

検索フラグ。フラグを指定しない場合、mmioDescend は現在のファイル位置から始まるチャンクへ降下します。次の値が定義されています。

値	意味
MMIO_FINDCHUNK	指定したチャンク識別子を持つチャンクを検索します。
MMIO_FINDLIST	チャンク識別子が "LIST" で、指定したフォームタイプを持つチャンクを検索します。
MMIO_FINDRIFF	チャンク識別子が "RIFF" で、指定したフォームタイプを持つチャンクを検索します。

戻り値の型: DWORD

公式ドキュメント

mmioDescend 関数は、mmioOpen 関数を使用して開かれた RIFF ファイル内のチャンクへ降下します。指定したチャンクを検索することもできます。

戻り値

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

戻り値	説明
MMIOERR_CHUNKNOTFOUND	目的のチャンクが見つかる前に、ファイルの末尾(親チャンクが指定されている場合はその末尾)に達しました。

解説(Remarks)

"RIFF" チャンクは、4 バイトのチャンク識別子(FOURCC 型)、それに続く 4 バイトのチャンクサイズ(DWORD 型)、それに続くチャンクのデータ部分、そしてデータ部分のサイズが奇数の場合は末尾の null パッドバイトで構成されます。チャンク識別子が "RIFF" または "LIST" の場合、チャンクのデータ部分の先頭 4 バイトはフォームタイプまたはリストタイプ(FOURCC 型)です。

mmioDescend を使用してチャンクを検索する場合は、関数を呼び出す前にファイル位置がチャンクの先頭にあることを確認してください。検索は現在のファイル位置から始まり、ファイルの末尾まで続きます。親チャンクが指定されている場合は、mmioDescend を呼び出す前にファイル位置が親チャンク内のいずれかの位置にある必要があります。この場合、検索は現在のファイル位置から始まり、親チャンクの末尾まで続きます。

mmioDescend がチャンクの検索に失敗した場合、現在のファイル位置は未定義です。mmioDescend が成功した場合、現在のファイル位置は変更されます。チャンクが "RIFF" または "LIST" チャンクの場合、新しいファイル位置はフォームタイプまたはリストタイプの直後(チャンクの先頭から 12 バイト)になります。それ以外のチャンクの場合、新しいファイル位置はチャンクのデータ部分の先頭(チャンクの先頭から 8 バイト)になります。

mmioDescend 関数は、lpck パラメーターが指す MMCKINFO 構造体に次の情報を設定します。

ckid メンバーはチャンクです。MMIO_FINDCHUNK、MMIO_FINDRIFF、または MMIO_FINDLIST フラグが wFlags に指定されている場合、MMCKINFO 構造体は mmioDescend へパラメーターを渡すためにも使用されます。この場合、ckid メンバーは、検索するチャンク識別子、フォームタイプ、またはリストタイプの 4 文字コードを指定します。
cksize メンバーは、チャンクのデータ部分のサイズ(バイト単位)です。このサイズにはフォームタイプまたはリストタイプ(存在する場合)が含まれますが、8 バイトのチャンクヘッダーやデータ末尾のパッドバイト(存在する場合)は含まれません。
fccType メンバーは、ckid が "RIFF" の場合はフォームタイプ、ckid が "LIST" の場合はリストタイプです。それ以外の場合は NULL です。
dwDataOffset メンバーは、チャンクのデータ部分の先頭のファイルオフセットです。チャンクが "RIFF" チャンクまたは "LIST" チャンクの場合、このメンバーはフォームタイプまたはリストタイプのオフセットです。
dwFlags メンバーには、チャンクに関するその他の情報が含まれます。現在この情報は使用されておらず、ゼロに設定されます。

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

各言語での呼び出し定義

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

DWORD mmioDescend(
    HMMIO hmmio,
    MMCKINFO* pmmcki,
    const MMCKINFO* pmmckiParent,   // optional
    DWORD fuDescend
);

[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint mmioDescend(
    IntPtr hmmio,   // HMMIO
    IntPtr pmmcki,   // MMCKINFO* in/out
    IntPtr pmmckiParent,   // MMCKINFO* optional
    uint fuDescend   // DWORD
);

<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function mmioDescend(
    hmmio As IntPtr,   ' HMMIO
    pmmcki As IntPtr,   ' MMCKINFO* in/out
    pmmckiParent As IntPtr,   ' MMCKINFO* optional
    fuDescend As UInteger   ' DWORD
) As UInteger
End Function

' hmmio : HMMIO
' pmmcki : MMCKINFO* in/out
' pmmckiParent : MMCKINFO* optional
' fuDescend : DWORD
Declare PtrSafe Function mmioDescend Lib "winmm" ( _
    ByVal hmmio As LongPtr, _
    ByVal pmmcki As LongPtr, _
    ByVal pmmckiParent As LongPtr, _
    ByVal fuDescend As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

mmioDescend = ctypes.windll.winmm.mmioDescend
mmioDescend.restype = wintypes.DWORD
mmioDescend.argtypes = [
    wintypes.HANDLE,  # hmmio : HMMIO
    ctypes.c_void_p,  # pmmcki : MMCKINFO* in/out
    ctypes.c_void_p,  # pmmckiParent : MMCKINFO* optional
    wintypes.DWORD,  # fuDescend : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
mmioDescend = Fiddle::Function.new(
  lib['mmioDescend'],
  [
    Fiddle::TYPE_VOIDP,  # hmmio : HMMIO
    Fiddle::TYPE_VOIDP,  # pmmcki : MMCKINFO* in/out
    Fiddle::TYPE_VOIDP,  # pmmckiParent : MMCKINFO* optional
    -Fiddle::TYPE_INT,  # fuDescend : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn mmioDescend(
        hmmio: *mut core::ffi::c_void,  // HMMIO
        pmmcki: *mut MMCKINFO,  // MMCKINFO* in/out
        pmmckiParent: *const MMCKINFO,  // MMCKINFO* optional
        fuDescend: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll")]
public static extern uint mmioDescend(IntPtr hmmio, IntPtr pmmcki, IntPtr pmmckiParent, uint fuDescend);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_mmioDescend' -Namespace Win32 -PassThru
# $api::mmioDescend(hmmio, pmmcki, pmmckiParent, fuDescend)

#uselib "WINMM.dll"
#func global mmioDescend "mmioDescend" sptr, sptr, sptr, sptr
; mmioDescend hmmio, varptr(pmmcki), varptr(pmmckiParent), fuDescend   ; 戻り値は stat
; hmmio : HMMIO -> "sptr"
; pmmcki : MMCKINFO* in/out -> "sptr"
; pmmckiParent : MMCKINFO* optional -> "sptr"
; fuDescend : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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