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

midiInUnprepareHeader

関数
準備済みのMIDI入力バッファの準備を解除する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiInUnprepareHeader(
    HMIDIIN hmi,
    MIDIHDR* pmh,
    DWORD cbmh
);

パラメーター

名前方向説明
hmiHMIDIINinMIDI 入力デバイスのハンドルです。
pmhMIDIHDR*inout後処理の対象となるバッファーを示す MIDIHDR 構造体へのポインターです。
cbmhDWORDinMIDIHDR 構造体のサイズです。

戻り値の型: DWORD

公式ドキュメント

midiInUnprepareHeader 関数は、midiInPrepareHeader 関数によって行われた準備の後処理を行います。

戻り値

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

戻り値 説明
MIDIERR_STILLPLAYING
lpMidiInHdr が指すバッファーがまだキュー内に存在します。
MMSYSERR_INVALPARAM
指定されたポインターまたは構造体が無効です。
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。

解説(Remarks)

この関数は midiInPrepareHeader と対になるものです。バッファーを解放する前に、この関数を使用する必要があります。midiInAddBuffer 関数を使用してバッファーをデバイスドライバーに渡した後は、ドライバーがそのバッファーの処理を完了するまで待ってから midiInUnprepareHeader を使用する必要があります。準備されていないバッファーに対して後処理を行っても何も起こらず、関数は 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 midiInUnprepareHeader(
    HMIDIIN hmi,
    MIDIHDR* pmh,
    DWORD cbmh
);
[DllImport("WINMM.dll", ExactSpelling = true)]
static extern uint midiInUnprepareHeader(
    IntPtr hmi,   // HMIDIIN
    IntPtr pmh,   // MIDIHDR* in/out
    uint cbmh   // DWORD
);
<DllImport("WINMM.dll", ExactSpelling:=True)>
Public Shared Function midiInUnprepareHeader(
    hmi As IntPtr,   ' HMIDIIN
    pmh As IntPtr,   ' MIDIHDR* in/out
    cbmh As UInteger   ' DWORD
) As UInteger
End Function
' hmi : HMIDIIN
' pmh : MIDIHDR* in/out
' cbmh : DWORD
Declare PtrSafe Function midiInUnprepareHeader Lib "winmm" ( _
    ByVal hmi 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

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

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiInUnprepareHeader = winmm.NewProc("midiInUnprepareHeader")
)

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

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

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

関連項目

使用する型