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

midiOutPrepareHeader

関数
MIDI出力用のシステムエクスクルーシブバッファを準備する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiOutPrepareHeader(
    HMIDIOUT hmo,
    MIDIHDR* pmh,
    DWORD cbmh
);

パラメーター

名前方向説明
hmoHMIDIOUTinMIDI 出力デバイスのハンドル。デバイスハンドルを取得するには、midiOutOpen を呼び出します。このパラメーターには、HMIDIOUT 型にキャストした MIDI ストリームのハンドルを指定することもできます。
pmhMIDIHDR*inout

準備するバッファを識別する MIDIHDR 構造体へのポインター。

関数を呼び出す前に、MIDIHDR 構造体の lpDatadwBufferLengthdwFlags の各メンバーを設定してください。dwFlags メンバーは 0 に設定する必要があります。

cbmhDWORDinMIDIHDR 構造体のサイズ(バイト単位)。

戻り値の型: DWORD

公式ドキュメント

midiOutPrepareHeader 関数は、出力用に MIDI システムエクスクルーシブバッファまたはストリームバッファを準備します。

戻り値

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

戻り値 説明
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。
MMSYSERR_INVALPARAM
指定されたアドレスが無効であるか、指定されたストリームバッファが 64K を超えています。
MMSYSERR_NOMEM
システムがメモリの割り当てまたはロックを実行できません。

解説(Remarks)

MIDI データブロックをデバイスドライバーに渡す前に、そのバッファを midiOutPrepareHeader 関数に渡して準備する必要があります。ヘッダーを準備した後は、バッファを変更しないでください。ドライバーがバッファの使用を終えたら、midiOutUnprepareHeader 関数を呼び出します。

アプリケーションは、同じバッファを再利用することも、複数のバッファを割り当ててそれぞれに対して midiOutPrepareHeader を呼び出すこともできます。同じバッファを再利用する場合は、毎回バッファを準備する必要はありません。最初に midiOutPrepareHeader を 1 回呼び出し、最後に midiOutUnprepareHeader を 1 回呼び出すだけで済みます。

ストリームバッファは 64K を超えることはできません。

すでに準備済みのヘッダーを準備しても何の効果もなく、関数は MMSYSERR_NOERROR を返します。

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

各言語での呼び出し定義

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

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

midiOutPrepareHeader = ctypes.windll.winmm.midiOutPrepareHeader
midiOutPrepareHeader.restype = wintypes.DWORD
midiOutPrepareHeader.argtypes = [
    wintypes.HANDLE,  # hmo : HMIDIOUT
    ctypes.c_void_p,  # pmh : MIDIHDR* in/out
    wintypes.DWORD,  # cbmh : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiOutPrepareHeader = Fiddle::Function.new(
  lib['midiOutPrepareHeader'],
  [
    Fiddle::TYPE_VOIDP,  # hmo : HMIDIOUT
    Fiddle::TYPE_VOIDP,  # pmh : MIDIHDR* in/out
    -Fiddle::TYPE_INT,  # cbmh : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn midiOutPrepareHeader(
        hmo: *mut core::ffi::c_void,  // HMIDIOUT
        pmh: *mut MIDIHDR,  // MIDIHDR* in/out
        cbmh: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint midiOutPrepareHeader(IntPtr hmo, IntPtr pmh, uint cbmh);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_midiOutPrepareHeader' -Namespace Win32 -PassThru
# $api::midiOutPrepareHeader(hmo, pmh, cbmh)
#uselib "WINMM.dll"
#func global midiOutPrepareHeader "midiOutPrepareHeader" sptr, sptr, sptr
; midiOutPrepareHeader hmo, varptr(pmh), cbmh   ; 戻り値は stat
; hmo : HMIDIOUT -> "sptr"
; pmh : MIDIHDR* in/out -> "sptr"
; cbmh : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINMM.dll"
#cfunc global midiOutPrepareHeader "midiOutPrepareHeader" sptr, var, int
; res = midiOutPrepareHeader(hmo, pmh, cbmh)
; hmo : HMIDIOUT -> "sptr"
; pmh : MIDIHDR* in/out -> "var"
; cbmh : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD midiOutPrepareHeader(HMIDIOUT hmo, MIDIHDR* pmh, DWORD cbmh)
#uselib "WINMM.dll"
#cfunc global midiOutPrepareHeader "midiOutPrepareHeader" intptr, var, int
; res = midiOutPrepareHeader(hmo, pmh, cbmh)
; hmo : HMIDIOUT -> "intptr"
; pmh : MIDIHDR* in/out -> "var"
; cbmh : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiOutPrepareHeader = winmm.NewProc("midiOutPrepareHeader")
)

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

extern "winmm" fn midiOutPrepareHeader(
    hmo: ?*anyopaque, // HMIDIOUT
    pmh: [*c]MIDIHDR, // MIDIHDR* in/out
    cbmh: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc midiOutPrepareHeader(
    hmo: pointer,  # HMIDIOUT
    pmh: ptr MIDIHDR,  # MIDIHDR* in/out
    cbmh: uint32  # DWORD
): uint32 {.importc: "midiOutPrepareHeader", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint midiOutPrepareHeader(
    void* hmo,   // HMIDIOUT
    MIDIHDR* pmh,   // MIDIHDR* in/out
    uint cbmh   // DWORD
);
ccall((:midiOutPrepareHeader, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{MIDIHDR}, UInt32),
      hmo, pmh, cbmh)
# hmo : HMIDIOUT -> Ptr{Cvoid}
# pmh : MIDIHDR* in/out -> Ptr{MIDIHDR}
# cbmh : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t midiOutPrepareHeader(
    void* hmo,
    void* pmh,
    uint32_t cbmh);
]]
local winmm = ffi.load("winmm")
-- winmm.midiOutPrepareHeader(hmo, pmh, cbmh)
-- hmo : HMIDIOUT
-- pmh : MIDIHDR* in/out
-- cbmh : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const midiOutPrepareHeader = lib.func('__stdcall', 'midiOutPrepareHeader', 'uint32_t', ['void *', 'void *', 'uint32_t']);
// midiOutPrepareHeader(hmo, pmh, cbmh)
// hmo : HMIDIOUT -> 'void *'
// pmh : MIDIHDR* in/out -> 'void *'
// cbmh : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  midiOutPrepareHeader: { parameters: ["pointer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.midiOutPrepareHeader(hmo, pmh, cbmh)
// hmo : HMIDIOUT -> "pointer"
// pmh : MIDIHDR* in/out -> "pointer"
// cbmh : DWORD -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t midiOutPrepareHeader(
    void* hmo,
    void* pmh,
    uint32_t cbmh);
C, "WINMM.dll");
// $ffi->midiOutPrepareHeader(hmo, pmh, cbmh);
// hmo : HMIDIOUT
// pmh : MIDIHDR* in/out
// cbmh : 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 midiOutPrepareHeader(
        Pointer hmo,   // HMIDIOUT
        Pointer pmh,   // MIDIHDR* in/out
        int cbmh   // DWORD
    );
}
@[Link("winmm")]
lib LibWINMM
  fun midiOutPrepareHeader = midiOutPrepareHeader(
    hmo : Void*,   # HMIDIOUT
    pmh : MIDIHDR*,   # MIDIHDR* in/out
    cbmh : 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 midiOutPrepareHeaderNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Uint32);
typedef midiOutPrepareHeaderDart = int Function(Pointer<Void>, Pointer<Void>, int);
final midiOutPrepareHeader = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<midiOutPrepareHeaderNative, midiOutPrepareHeaderDart>('midiOutPrepareHeader');
// hmo : HMIDIOUT -> Pointer<Void>
// pmh : MIDIHDR* in/out -> Pointer<Void>
// cbmh : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function midiOutPrepareHeader(
  hmo: THandle;   // HMIDIOUT
  pmh: Pointer;   // MIDIHDR* in/out
  cbmh: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiOutPrepareHeader';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "midiOutPrepareHeader"
  c_midiOutPrepareHeader :: Ptr () -> Ptr () -> Word32 -> IO Word32
-- hmo : HMIDIOUT -> Ptr ()
-- pmh : MIDIHDR* in/out -> Ptr ()
-- cbmh : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let midioutprepareheader =
  foreign "midiOutPrepareHeader"
    ((ptr void) @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hmo : HMIDIOUT -> (ptr void) *)
(* pmh : MIDIHDR* in/out -> (ptr void) *)
(* cbmh : 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 ("midiOutPrepareHeader" midi-out-prepare-header :convention :stdcall) :uint32
  (hmo :pointer)   ; HMIDIOUT
  (pmh :pointer)   ; MIDIHDR* in/out
  (cbmh :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $midiOutPrepareHeader = Win32::API::More->new('WINMM',
    'DWORD midiOutPrepareHeader(HANDLE hmo, LPVOID pmh, DWORD cbmh)');
# my $ret = $midiOutPrepareHeader->Call($hmo, $pmh, $cbmh);
# hmo : HMIDIOUT -> HANDLE
# pmh : MIDIHDR* in/out -> LPVOID
# cbmh : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型