midiOutGetDevCapsA

関数

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

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

シグネチャ

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

DWORD midiOutGetDevCapsA(
    UINT_PTR uDeviceID,
    MIDIOUTCAPSA* pmoc,
    DWORD cbmoc
);

パラメーター

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

名前

型

方向

説明

uDeviceID

UINT_PTR

MIDI 出力デバイスの識別子。このパラメーターで指定するデバイス識別子は、0 から、存在するデバイス数より 1 小さい値までの範囲になります。MIDI_MAPPER 定数も有効なデバイス識別子です。

このパラメーターには、適切にキャストしたデバイスハンドルを指定することもできます。

pmoc

MIDIOUTCAPSA*

out

MIDIOUTCAPS 構造体へのポインター。この構造体には、デバイスの機能に関する情報が格納されます。

cbmoc

DWORD

MIDIOUTCAPS 構造体のサイズ(バイト単位)。lpMidiOutCaps が指す位置にコピーされる情報は、cbMidiOutCaps バイト(またはそれ以下)のみです。cbMidiOutCaps が 0 の場合は何もコピーされず、関数は MMSYSERR_NOERROR を返します。

戻り値の型: DWORD

公式ドキュメント

midiOutGetDevCaps 関数は、指定した MIDI 出力デバイスに問い合わせて、その機能を取得します。(midiOutGetDevCapsA)

戻り値

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

戻り値	説明
MMSYSERR_BADDEVICEID	指定したデバイス識別子が範囲外です。
MMSYSERR_INVALPARAM	指定したポインターまたは構造体が無効です。
MMSYSERR_NODRIVER	ドライバーがインストールされていません。
MMSYSERR_NOMEM	システムがマッパーの文字列記述を読み込めません。

解説(Remarks)

システムに存在する MIDI 出力デバイスの数を調べるには、midiOutGetNumDevs 関数を使用します。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 midiOutGetDevCapsA(
    UINT_PTR uDeviceID,
    MIDIOUTCAPSA* pmoc,
    DWORD cbmoc
);

[DllImport("WINMM.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint midiOutGetDevCapsA(
    UIntPtr uDeviceID,   // UINT_PTR
    IntPtr pmoc,   // MIDIOUTCAPSA* out
    uint cbmoc   // DWORD
);

<DllImport("WINMM.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function midiOutGetDevCapsA(
    uDeviceID As UIntPtr,   ' UINT_PTR
    pmoc As IntPtr,   ' MIDIOUTCAPSA* out
    cbmoc As UInteger   ' DWORD
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

midiOutGetDevCapsA = ctypes.windll.winmm.midiOutGetDevCapsA
midiOutGetDevCapsA.restype = wintypes.DWORD
midiOutGetDevCapsA.argtypes = [
    ctypes.c_size_t,  # uDeviceID : UINT_PTR
    ctypes.c_void_p,  # pmoc : MIDIOUTCAPSA* out
    wintypes.DWORD,  # cbmoc : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiOutGetDevCapsA = Fiddle::Function.new(
  lib['midiOutGetDevCapsA'],
  [
    Fiddle::TYPE_UINTPTR_T,  # uDeviceID : UINT_PTR
    Fiddle::TYPE_VOIDP,  # pmoc : MIDIOUTCAPSA* out
    -Fiddle::TYPE_INT,  # cbmoc : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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