midiInGetErrorTextA

関数

MIDI入力エラーコードに対応する説明文を取得する(ANSI版)。

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

シグネチャ

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

DWORD midiInGetErrorTextA(
    DWORD mmrError,
    LPSTR pszText,
    DWORD cchText
);

パラメーター

名前	型	方向	説明
mmrError	DWORD	in	エラーコード。
pszText	LPSTR	out	テキスト形式のエラー説明で埋めるバッファへのポインター。
cchText	DWORD	in	lpText が指すバッファの長さ(文字数単位)。

戻り値の型: DWORD

公式ドキュメント

midiInGetErrorText 関数は、指定されたエラーコードで識別されるエラーのテキスト形式の説明を取得します。(midiInGetErrorTextA)

戻り値

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

戻り値	説明
MMSYSERR_BADERRNUM	指定されたエラー番号が範囲外です。
MMSYSERR_INVALPARAM	指定されたポインターまたは構造体が無効です。
MMSYSERR_NOMEM	システムがメモリを割り当てるか、ロックすることができません。

解説(Remarks)

テキスト形式のエラー説明が指定されたバッファより長い場合、説明は切り詰められます。返されるエラー文字列は常に null で終端されます。cchText が 0 の場合、何もコピーされず、関数は 0 を返します。すべてのエラー説明は MAXERRORLENGTH 文字未満の長さです。

メモ

mmeapi.h ヘッダーは、midiInGetErrorText を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、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 midiInGetErrorTextA(
    DWORD mmrError,
    LPSTR pszText,
    DWORD cchText
);

[DllImport("WINMM.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint midiInGetErrorTextA(
    uint mmrError,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszText,   // LPSTR out
    uint cchText   // DWORD
);

<DllImport("WINMM.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function midiInGetErrorTextA(
    mmrError As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> pszText As System.Text.StringBuilder,   ' LPSTR out
    cchText As UInteger   ' DWORD
) As UInteger
End Function

' mmrError : DWORD
' pszText : LPSTR out
' cchText : DWORD
Declare PtrSafe Function midiInGetErrorTextA Lib "winmm" ( _
    ByVal mmrError As Long, _
    ByVal pszText As String, _
    ByVal cchText As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

midiInGetErrorTextA = ctypes.windll.winmm.midiInGetErrorTextA
midiInGetErrorTextA.restype = wintypes.DWORD
midiInGetErrorTextA.argtypes = [
    wintypes.DWORD,  # mmrError : DWORD
    wintypes.LPSTR,  # pszText : LPSTR out
    wintypes.DWORD,  # cchText : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
midiInGetErrorTextA = Fiddle::Function.new(
  lib['midiInGetErrorTextA'],
  [
    -Fiddle::TYPE_INT,  # mmrError : DWORD
    Fiddle::TYPE_VOIDP,  # pszText : LPSTR out
    -Fiddle::TYPE_INT,  # cchText : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "winmm")]
extern "system" {
    fn midiInGetErrorTextA(
        mmrError: u32,  // DWORD
        pszText: *mut u8,  // LPSTR out
        cchText: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("WINMM.dll", CharSet = CharSet.Ansi)]
public static extern uint midiInGetErrorTextA(uint mmrError, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder pszText, uint cchText);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_midiInGetErrorTextA' -Namespace Win32 -PassThru
# $api::midiInGetErrorTextA(mmrError, pszText, cchText)

#uselib "WINMM.dll"
#func global midiInGetErrorTextA "midiInGetErrorTextA" sptr, sptr, sptr
; midiInGetErrorTextA mmrError, varptr(pszText), cchText   ; 戻り値は stat
; mmrError : DWORD -> "sptr"
; pszText : LPSTR out -> "sptr"
; cchText : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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