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

midiInStart

関数
MIDI入力デバイスの受信を開始する。
DLLWINMM.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD midiInStart(
    HMIDIIN hmi
);

パラメーター

名前方向説明
hmiHMIDIINinMIDI 入力デバイスのハンドル。

戻り値の型: DWORD

公式ドキュメント

midiInStart 関数は、指定された MIDI 入力デバイスでの MIDI 入力を開始します。

戻り値

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

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

解説(Remarks)

この関数はタイムスタンプをゼロにリセットします。以降に受信されるメッセージのタイムスタンプ値は、この関数が呼び出された時刻を基準とした相対値になります。

システムエクスクルーシブメッセージを除くすべてのメッセージは、受信されるとクライアントへ直接送信されます。システムエクスクルーシブメッセージは、midiInAddBuffer 関数によって指定されたバッファーに格納されます。キューにバッファーが存在しない場合、システムエクスクルーシブデータはクライアントへ通知されることなく破棄され、入力は継続されます。バッファーは、満杯になったとき、完全なシステムエクスクルーシブメッセージを受信したとき、または midiInReset 関数が使用されたときに、クライアントへ返されます。MIDIHDR 構造体の dwBytesRecorded メンバーには、実際に受信したデータの長さが格納されます。

入力が既に開始されている状態でこの関数を呼び出しても効果はなく、関数はゼロを返します。

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

各言語での呼び出し定義

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

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

midiInStart = ctypes.windll.winmm.midiInStart
midiInStart.restype = wintypes.DWORD
midiInStart.argtypes = [
    wintypes.HANDLE,  # hmi : HMIDIIN
]
require 'fiddle'
require 'fiddle/import'

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

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procmidiInStart = winmm.NewProc("midiInStart")
)

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

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

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

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

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

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