midiInGetDevCapsA

関数

MIDI入力デバイスの機能を取得する(ANSI版)。

DLLWINMM.dll文字セットANSI (-A)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD midiInGetDevCapsA(
    UINT_PTR uDeviceID,
    MIDIINCAPSA* pmic,
    DWORD cbmic
);

パラメーター

名前	型	方向	説明
uDeviceID	UINT_PTR	in	MIDI 入力デバイスの識別子。デバイス識別子は 0 から、存在するデバイス数より 1 小さい値までの範囲を取ります。このパラメーターには、適切にキャストされたデバイスハンドルを指定することもできます。
pmic	MIDIINCAPSA*	out	デバイスの機能に関する情報が格納される MIDIINCAPS 構造体へのポインター。
cbmic	DWORD	in	MIDIINCAPS 構造体のサイズ(バイト単位)。lpMidiInCaps が指す場所には、cbMidiInCaps バイト分(またはそれ以下)の情報のみがコピーされます。cbMidiInCaps が 0 の場合、何もコピーされず、関数は MMSYSERR_NOERROR を返します。

戻り値の型: DWORD

公式ドキュメント

midiInGetDevCaps 関数は、指定された MIDI 入力デバイスの機能を取得します。(midiInGetDevCapsA)

戻り値

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

戻り値	説明
MMSYSERR_BADDEVICEID	指定されたデバイス識別子が範囲外です。
MMSYSERR_INVALPARAM	指定されたポインターまたは構造体が無効です。
MMSYSERR_NODRIVER	ドライバーがインストールされていません。
MMSYSERR_NOMEM	システムがメモリを割り当てまたはロックできません。

解説(Remarks)

システムに存在する MIDI 入力デバイスの数を確認するには、midiInGetNumDevs 関数を使用します。

メモ

mmeapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして midiInGetDevCaps を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存でないコードを混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

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

各言語での呼び出し定義

// WINMM.dll  (ANSI / -A)
#include <windows.h>

DWORD midiInGetDevCapsA(
    UINT_PTR uDeviceID,
    MIDIINCAPSA* pmic,
    DWORD cbmic
);

[DllImport("WINMM.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint midiInGetDevCapsA(
    UIntPtr uDeviceID,   // UINT_PTR
    IntPtr pmic,   // MIDIINCAPSA* out
    uint cbmic   // DWORD
);

<DllImport("WINMM.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function midiInGetDevCapsA(
    uDeviceID As UIntPtr,   ' UINT_PTR
    pmic As IntPtr,   ' MIDIINCAPSA* out
    cbmic As UInteger   ' DWORD
) As UInteger
End Function

' uDeviceID : UINT_PTR
' pmic : MIDIINCAPSA* out
' cbmic : DWORD
Declare PtrSafe Function midiInGetDevCapsA Lib "winmm" ( _
    ByVal uDeviceID As LongPtr, _
    ByVal pmic As LongPtr, _
    ByVal cbmic As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

midiInGetDevCapsA = ctypes.windll.winmm.midiInGetDevCapsA
midiInGetDevCapsA.restype = wintypes.DWORD
midiInGetDevCapsA.argtypes = [
    ctypes.c_size_t,  # uDeviceID : UINT_PTR
    ctypes.c_void_p,  # pmic : MIDIINCAPSA* out
    wintypes.DWORD,  # cbmic : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiInGetDevCapsA = Fiddle::Function.new(
  lib['midiInGetDevCapsA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # uDeviceID : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pmic : MIDIINCAPSA* out
    -Fiddle::TYPE_INT,  # cbmic : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn midiInGetDevCapsA(
        uDeviceID: usize,  // UINT_PTR
        pmic: *mut MIDIINCAPSA,  // MIDIINCAPSA* out
        cbmic: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll", CharSet = CharSet.Ansi)]
public static extern uint midiInGetDevCapsA(UIntPtr uDeviceID, IntPtr pmic, uint cbmic);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_midiInGetDevCapsA' -Namespace Win32 -PassThru
# $api::midiInGetDevCapsA(uDeviceID, pmic, cbmic)

#uselib "WINMM.dll"
#func global midiInGetDevCapsA "midiInGetDevCapsA" sptr, sptr, sptr
; midiInGetDevCapsA uDeviceID, varptr(pmic), cbmic   ; 戻り値は stat
; uDeviceID : UINT_PTR -> "sptr"
; pmic : MIDIINCAPSA* out -> "sptr"
; cbmic : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "WINMM.dll"
#cfunc global midiInGetDevCapsA "midiInGetDevCapsA" sptr, var, int
; res = midiInGetDevCapsA(uDeviceID, pmic, cbmic)
; uDeviceID : UINT_PTR -> "sptr"
; pmic : MIDIINCAPSA* out -> "var"
; cbmic : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WINMM.dll"
#cfunc global midiInGetDevCapsA "midiInGetDevCapsA" sptr, sptr, int
; res = midiInGetDevCapsA(uDeviceID, varptr(pmic), cbmic)
; uDeviceID : UINT_PTR -> "sptr"
; pmic : MIDIINCAPSA* out -> "sptr"
; cbmic : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。