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

waveOutUnprepareHeader

関数
準備済みの波形出力データブロックの準備を解除する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD waveOutUnprepareHeader(
    HWAVEOUT hwo,
    WAVEHDR* pwh,
    DWORD cbwh
);

パラメーター

名前方向説明
hwoHWAVEOUTin波形オーディオ出力デバイスへのハンドルです。
pwhWAVEHDR*inout解放対象のデータブロックを識別する WAVEHDR 構造体へのポインターです。
cbwhDWORDinWAVEHDR 構造体のサイズ(バイト単位)です。

戻り値の型: DWORD

公式ドキュメント

waveOutUnprepareHeader 関数は、waveOutPrepareHeader 関数で行った準備を解放します。この関数は、デバイスドライバーがデータブロックの処理を終えた後に呼び出す必要があります。バッファーを解放する前に、この関数を呼び出す必要があります。

戻り値

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

戻り値 説明
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。
MMSYSERR_NODRIVER
デバイスドライバーが存在しません。
MMSYSERR_NOMEM
メモリの確保またはロックができません。
WAVERR_STILLPLAYING
pwh パラメーターが指すデータブロックがまだキューに残っています。

解説(Remarks)

この関数は waveOutPrepareHeader と対になるものです。バッファーを解放する前に、この関数を呼び出す必要があります。waveOutWrite 関数でバッファーをデバイスドライバーに渡した後は、ドライバーがそのバッファーの処理を終えるまで待ってから waveOutUnprepareHeader を呼び出す必要があります。

準備されていないバッファーを解放しても何も起こらず、関数はゼロを返します。

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

各言語での呼び出し定義

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

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

waveOutUnprepareHeader = ctypes.windll.winmm.waveOutUnprepareHeader
waveOutUnprepareHeader.restype = wintypes.DWORD
waveOutUnprepareHeader.argtypes = [
    wintypes.HANDLE,  # hwo : HWAVEOUT
    ctypes.c_void_p,  # pwh : WAVEHDR* in/out
    wintypes.DWORD,  # cbwh : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procwaveOutUnprepareHeader = winmm.NewProc("waveOutUnprepareHeader")
)

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

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

foreign import stdcall safe "waveOutUnprepareHeader"
  c_waveOutUnprepareHeader :: Ptr () -> Ptr () -> Word32 -> IO Word32
-- hwo : HWAVEOUT -> Ptr ()
-- pwh : WAVEHDR* in/out -> Ptr ()
-- cbwh : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

使用する型