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

midiOutReset

関数
MIDI出力デバイスをリセットし全ノートをオフにする。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiOutReset(
    HMIDIOUT hmo
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

midiOutReset 関数は、指定された MIDI 出力デバイスのすべての MIDI チャンネルで、すべてのノートをオフにします。

戻り値

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

戻り値 説明
MMSYSERR_INVALHANDLE
指定されたデバイスハンドルが無効です。

解説(Remarks)

保留中のシステムエクスクルーシブまたはストリーム出力バッファーはコールバック関数に返され、MIDIHDR 構造体の dwFlags メンバーに MHDR_DONE フラグが設定されます。

EOX (end-of-exclusive) バイトを送信せずにシステムエクスクルーシブメッセージを終了すると、受信側デバイスで問題が発生する可能性があります。midiOutReset 関数は、システムエクスクルーシブメッセージを終了する際に EOX バイトを送信しません。これはアプリケーション側の責任で行う必要があります。

すべてのノートをオフにするため、各チャンネルの各ノートに対してノートオフメッセージが送信されます。さらに、各チャンネルでサステインコントローラーがオフにされます。

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

各言語での呼び出し定義

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

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

midiOutReset = ctypes.windll.winmm.midiOutReset
midiOutReset.restype = wintypes.DWORD
midiOutReset.argtypes = [
    wintypes.HANDLE,  # hmo : HMIDIOUT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiOutReset = Fiddle::Function.new(
  lib['midiOutReset'],
  [
    Fiddle::TYPE_VOIDP,  # hmo : HMIDIOUT
  ],
  -Fiddle::TYPE_INT)
#[link(name = "winmm")]
extern "system" {
    fn midiOutReset(
        hmo: *mut core::ffi::c_void  // HMIDIOUT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll")]
public static extern uint midiOutReset(IntPtr hmo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_midiOutReset' -Namespace Win32 -PassThru
# $api::midiOutReset(hmo)
#uselib "WINMM.dll"
#func global midiOutReset "midiOutReset" sptr
; midiOutReset hmo   ; 戻り値は stat
; hmo : HMIDIOUT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "WINMM.dll"
#cfunc global midiOutReset "midiOutReset" sptr
; res = midiOutReset(hmo)
; hmo : HMIDIOUT -> "sptr"
; DWORD midiOutReset(HMIDIOUT hmo)
#uselib "WINMM.dll"
#cfunc global midiOutReset "midiOutReset" intptr
; res = midiOutReset(hmo)
; hmo : HMIDIOUT -> "intptr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiOutReset = winmm.NewProc("midiOutReset")
)

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

extern "winmm" fn midiOutReset(
    hmo: ?*anyopaque // HMIDIOUT
) callconv(std.os.windows.WINAPI) u32;
proc midiOutReset(
    hmo: pointer  # HMIDIOUT
): uint32 {.importc: "midiOutReset", stdcall, dynlib: "WINMM.dll".}
pragma(lib, "winmm");
extern(Windows)
uint midiOutReset(
    void* hmo   // HMIDIOUT
);
ccall((:midiOutReset, "WINMM.dll"), stdcall, UInt32,
      (Ptr{Cvoid},),
      hmo)
# hmo : HMIDIOUT -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t midiOutReset(
    void* hmo);
]]
local winmm = ffi.load("winmm")
-- winmm.midiOutReset(hmo)
-- hmo : HMIDIOUT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const midiOutReset = lib.func('__stdcall', 'midiOutReset', 'uint32_t', ['void *']);
// midiOutReset(hmo)
// hmo : HMIDIOUT -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  midiOutReset: { parameters: ["pointer"], result: "u32" },
});
// lib.symbols.midiOutReset(hmo)
// hmo : HMIDIOUT -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t midiOutReset(
    void* hmo);
C, "WINMM.dll");
// $ffi->midiOutReset(hmo);
// hmo : HMIDIOUT
// 構造体/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 midiOutReset(
        Pointer hmo   // HMIDIOUT
    );
}
@[Link("winmm")]
lib LibWINMM
  fun midiOutReset = midiOutReset(
    hmo : Void*   # HMIDIOUT
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef midiOutResetNative = Uint32 Function(Pointer<Void>);
typedef midiOutResetDart = int Function(Pointer<Void>);
final midiOutReset = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<midiOutResetNative, midiOutResetDart>('midiOutReset');
// hmo : HMIDIOUT -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function midiOutReset(
  hmo: THandle   // HMIDIOUT
): DWORD; stdcall;
  external 'WINMM.dll' name 'midiOutReset';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "midiOutReset"
  c_midiOutReset :: Ptr () -> IO Word32
-- hmo : HMIDIOUT -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let midioutreset =
  foreign "midiOutReset"
    ((ptr void) @-> returning uint32_t)
(* hmo : HMIDIOUT -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("midiOutReset" midi-out-reset :convention :stdcall) :uint32
  (hmo :pointer))   ; HMIDIOUT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $midiOutReset = Win32::API::More->new('WINMM',
    'DWORD midiOutReset(HANDLE hmo)');
# my $ret = $midiOutReset->Call($hmo);
# hmo : HMIDIOUT -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。