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

waveOutGetErrorTextW

関数
波形出力エラーコードに対応する説明文を取得する(Unicode版)。
DLLWINMM.dll文字セットUnicode (-W)呼出規約winapi

シグネチャ

// WINMM.dll  (Unicode / -W)
#include <windows.h>

DWORD waveOutGetErrorTextW(
    DWORD mmrError,
    LPWSTR pszText,
    DWORD cchText
);

パラメーター

名前方向説明
mmrErrorDWORDinテキスト化する波形オーディオ系APIのエラーコード(MMRESULT値)。
pszTextLPWSTRoutエラー説明文字列(Unicode)を受け取るバッファへのポインタ。NULL指定で必要長を取得可能。
cchTextDWORDinpszTextバッファのサイズ(文字数)。終端NUL分を含む。

戻り値の型: DWORD

各言語での呼び出し定義

// WINMM.dll  (Unicode / -W)
#include <windows.h>

DWORD waveOutGetErrorTextW(
    DWORD mmrError,
    LPWSTR pszText,
    DWORD cchText
);
[DllImport("WINMM.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint waveOutGetErrorTextW(
    uint mmrError,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszText,   // LPWSTR out
    uint cchText   // DWORD
);
<DllImport("WINMM.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function waveOutGetErrorTextW(
    mmrError As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> pszText As System.Text.StringBuilder,   ' LPWSTR out
    cchText As UInteger   ' DWORD
) As UInteger
End Function
' mmrError : DWORD
' pszText : LPWSTR out
' cchText : DWORD
Declare PtrSafe Function waveOutGetErrorTextW Lib "winmm" ( _
    ByVal mmrError As Long, _
    ByVal pszText As LongPtr, _
    ByVal cchText As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

waveOutGetErrorTextW = ctypes.windll.winmm.waveOutGetErrorTextW
waveOutGetErrorTextW.restype = wintypes.DWORD
waveOutGetErrorTextW.argtypes = [
    wintypes.DWORD,  # mmrError : DWORD
    wintypes.LPWSTR,  # pszText : LPWSTR out
    wintypes.DWORD,  # cchText : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WINMM.dll')
waveOutGetErrorTextW = Fiddle::Function.new(
  lib['waveOutGetErrorTextW'],
  [
    -Fiddle::TYPE_INT,  # mmrError : DWORD
    Fiddle::TYPE_VOIDP,  # pszText : LPWSTR out
    -Fiddle::TYPE_INT,  # cchText : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "winmm")]
extern "system" {
    fn waveOutGetErrorTextW(
        mmrError: u32,  // DWORD
        pszText: *mut u16,  // LPWSTR out
        cchText: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("WINMM.dll", CharSet = CharSet.Unicode)]
public static extern uint waveOutGetErrorTextW(uint mmrError, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder pszText, uint cchText);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WINMM_waveOutGetErrorTextW' -Namespace Win32 -PassThru
# $api::waveOutGetErrorTextW(mmrError, pszText, cchText)
#uselib "WINMM.dll"
#func global waveOutGetErrorTextW "waveOutGetErrorTextW" wptr, wptr, wptr
; waveOutGetErrorTextW mmrError, varptr(pszText), cchText   ; 戻り値は stat
; mmrError : DWORD -> "wptr"
; pszText : LPWSTR out -> "wptr"
; cchText : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WINMM.dll"
#cfunc global waveOutGetErrorTextW "waveOutGetErrorTextW" int, var, int
; res = waveOutGetErrorTextW(mmrError, pszText, cchText)
; mmrError : DWORD -> "int"
; pszText : LPWSTR out -> "var"
; cchText : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD waveOutGetErrorTextW(DWORD mmrError, LPWSTR pszText, DWORD cchText)
#uselib "WINMM.dll"
#cfunc global waveOutGetErrorTextW "waveOutGetErrorTextW" int, var, int
; res = waveOutGetErrorTextW(mmrError, pszText, cchText)
; mmrError : DWORD -> "int"
; pszText : LPWSTR out -> "var"
; cchText : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	winmm = windows.NewLazySystemDLL("WINMM.dll")
	procwaveOutGetErrorTextW = winmm.NewProc("waveOutGetErrorTextW")
)

// mmrError (DWORD), pszText (LPWSTR out), cchText (DWORD)
r1, _, err := procwaveOutGetErrorTextW.Call(
	uintptr(mmrError),
	uintptr(pszText),
	uintptr(cchText),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function waveOutGetErrorTextW(
  mmrError: DWORD;   // DWORD
  pszText: PWideChar;   // LPWSTR out
  cchText: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'waveOutGetErrorTextW';
result := DllCall("WINMM\waveOutGetErrorTextW"
    , "UInt", mmrError   ; DWORD
    , "Ptr", pszText   ; LPWSTR out
    , "UInt", cchText   ; DWORD
    , "UInt")   ; return: DWORD
●waveOutGetErrorTextW(mmrError, pszText, cchText) = DLL("WINMM.dll", "dword waveOutGetErrorTextW(dword, char*, dword)")
# 呼び出し: waveOutGetErrorTextW(mmrError, pszText, cchText)
# mmrError : DWORD -> "dword"
# pszText : LPWSTR out -> "char*"
# cchText : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "winmm" fn waveOutGetErrorTextW(
    mmrError: u32, // DWORD
    pszText: [*c]u16, // LPWSTR out
    cchText: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc waveOutGetErrorTextW(
    mmrError: uint32,  # DWORD
    pszText: ptr uint16,  # LPWSTR out
    cchText: uint32  # DWORD
): uint32 {.importc: "waveOutGetErrorTextW", stdcall, dynlib: "WINMM.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "winmm");
extern(Windows)
uint waveOutGetErrorTextW(
    uint mmrError,   // DWORD
    wchar* pszText,   // LPWSTR out
    uint cchText   // DWORD
);
ccall((:waveOutGetErrorTextW, "WINMM.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt16}, UInt32),
      mmrError, pszText, cchText)
# mmrError : DWORD -> UInt32
# pszText : LPWSTR out -> Ptr{UInt16}
# cchText : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t waveOutGetErrorTextW(
    uint32_t mmrError,
    uint16_t* pszText,
    uint32_t cchText);
]]
local winmm = ffi.load("winmm")
-- winmm.waveOutGetErrorTextW(mmrError, pszText, cchText)
-- mmrError : DWORD
-- pszText : LPWSTR out
-- cchText : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('WINMM.dll');
const waveOutGetErrorTextW = lib.func('__stdcall', 'waveOutGetErrorTextW', 'uint32_t', ['uint32_t', 'uint16_t *', 'uint32_t']);
// waveOutGetErrorTextW(mmrError, pszText, cchText)
// mmrError : DWORD -> 'uint32_t'
// pszText : LPWSTR out -> 'uint16_t *'
// cchText : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("WINMM.dll", {
  waveOutGetErrorTextW: { parameters: ["u32", "buffer", "u32"], result: "u32" },
});
// lib.symbols.waveOutGetErrorTextW(mmrError, pszText, cchText)
// mmrError : DWORD -> "u32"
// pszText : LPWSTR out -> "buffer"
// cchText : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t waveOutGetErrorTextW(
    uint32_t mmrError,
    uint16_t* pszText,
    uint32_t cchText);
C, "WINMM.dll");
// $ffi->waveOutGetErrorTextW(mmrError, pszText, cchText);
// mmrError : DWORD
// pszText : LPWSTR out
// cchText : DWORD
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int waveOutGetErrorTextW(
        int mmrError,   // DWORD
        char[] pszText,   // LPWSTR out
        int cchText   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("winmm")]
lib LibWINMM
  fun waveOutGetErrorTextW = waveOutGetErrorTextW(
    mmrError : UInt32,   # DWORD
    pszText : UInt16*,   # LPWSTR out
    cchText : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef waveOutGetErrorTextWNative = Uint32 Function(Uint32, Pointer<Utf16>, Uint32);
typedef waveOutGetErrorTextWDart = int Function(int, Pointer<Utf16>, int);
final waveOutGetErrorTextW = DynamicLibrary.open('WINMM.dll')
    .lookupFunction<waveOutGetErrorTextWNative, waveOutGetErrorTextWDart>('waveOutGetErrorTextW');
// mmrError : DWORD -> Uint32
// pszText : LPWSTR out -> Pointer<Utf16>
// cchText : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function waveOutGetErrorTextW(
  mmrError: DWORD;   // DWORD
  pszText: PWideChar;   // LPWSTR out
  cchText: DWORD   // DWORD
): DWORD; stdcall;
  external 'WINMM.dll' name 'waveOutGetErrorTextW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "waveOutGetErrorTextW"
  c_waveOutGetErrorTextW :: Word32 -> CWString -> Word32 -> IO Word32
-- mmrError : DWORD -> Word32
-- pszText : LPWSTR out -> CWString
-- cchText : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let waveoutgeterrortextw =
  foreign "waveOutGetErrorTextW"
    (uint32_t @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* mmrError : DWORD -> uint32_t *)
(* pszText : LPWSTR out -> (ptr uint16_t) *)
(* cchText : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library winmm (t "WINMM.dll"))
(cffi:use-foreign-library winmm)

(cffi:defcfun ("waveOutGetErrorTextW" wave-out-get-error-text-w :convention :stdcall) :uint32
  (mmr-error :uint32)   ; DWORD
  (psz-text :pointer)   ; LPWSTR out
  (cch-text :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $waveOutGetErrorTextW = Win32::API::More->new('WINMM',
    'DWORD waveOutGetErrorTextW(DWORD mmrError, LPWSTR pszText, DWORD cchText)');
# my $ret = $waveOutGetErrorTextW->Call($mmrError, $pszText, $cchText);
# mmrError : DWORD -> DWORD
# pszText : LPWSTR out -> LPWSTR
# cchText : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い