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

acmFormatTagEnumW

関数
利用可能な波形フォーマットタグを列挙しコールバックへ通知する。Unicode版。
DLLMSACM32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD acmFormatTagEnumW(
    HACMDRIVER had,
    ACMFORMATTAGDETAILSW* paftd,
    ACMFORMATTAGENUMCBW fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

パラメーター

名前方向説明
hadHACMDRIVERin波形オーディオのフォーマットタグの詳細を照会する ACM ドライバーのハンドル。このパラメーターが NULL の場合、ACM は最初に見つかった適切な ACM ドライバーの詳細を使用します。
paftdACMFORMATTAGDETAILSW*inoutfnCallback で指定された関数に渡されるフォーマットタグの詳細を受け取る ACMFORMATTAGDETAILS 構造体へのポインター。この構造体は、ACMFORMATTAGDETAILS 構造体の cbStruct メンバーを初期化しておく必要があります。
fnCallbackACMFORMATTAGENUMCBWinアプリケーション定義のコールバック関数のプロシージャインスタンスアドレス。
dwInstanceUINT_PTRinACM フォーマットタグの詳細とともにコールバック関数に渡される、64 ビット (DWORD_PTR) または 32 ビット (DWORD) のアプリケーション定義の値。
fdwEnumDWORDin予約済み。ゼロを指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

acmFormatTagEnum (Unicode) 関数は、ACM ドライバーから利用可能な波形オーディオのフォーマットタグを列挙します。この関数は、適切なフォーマットタグがなくなるか、コールバック関数が FALSE を返すまで列挙を続けます。(acmFormatTagEnumW)

戻り値

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

戻り値 説明
MMSYSERR_INVALFLAG
少なくとも 1 つのフラグが無効です。
MMSYSERR_INVALHANDLE
指定されたハンドルが無効です。
MMSYSERR_INVALPARAM
少なくとも 1 つのパラメーターが無効です。

解説(Remarks)

適切な ACM ドライバーが 1 つもインストールされていない場合、この関数は MMSYSERR_NOERROR (ゼロ) を返します。また、その場合はコールバック関数は呼び出されません。

メモ

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

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

各言語での呼び出し定義

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

DWORD acmFormatTagEnumW(
    HACMDRIVER had,
    ACMFORMATTAGDETAILSW* paftd,
    ACMFORMATTAGENUMCBW fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);
[DllImport("MSACM32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint acmFormatTagEnumW(
    IntPtr had,   // HACMDRIVER
    IntPtr paftd,   // ACMFORMATTAGDETAILSW* in/out
    IntPtr fnCallback,   // ACMFORMATTAGENUMCBW
    UIntPtr dwInstance,   // UINT_PTR
    uint fdwEnum   // DWORD
);
<DllImport("MSACM32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function acmFormatTagEnumW(
    had As IntPtr,   ' HACMDRIVER
    paftd As IntPtr,   ' ACMFORMATTAGDETAILSW* in/out
    fnCallback As IntPtr,   ' ACMFORMATTAGENUMCBW
    dwInstance As UIntPtr,   ' UINT_PTR
    fdwEnum As UInteger   ' DWORD
) As UInteger
End Function
' had : HACMDRIVER
' paftd : ACMFORMATTAGDETAILSW* in/out
' fnCallback : ACMFORMATTAGENUMCBW
' dwInstance : UINT_PTR
' fdwEnum : DWORD
Declare PtrSafe Function acmFormatTagEnumW Lib "msacm32" ( _
    ByVal had As LongPtr, _
    ByVal paftd As LongPtr, _
    ByVal fnCallback As LongPtr, _
    ByVal dwInstance As LongPtr, _
    ByVal fdwEnum 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

acmFormatTagEnumW = ctypes.windll.msacm32.acmFormatTagEnumW
acmFormatTagEnumW.restype = wintypes.DWORD
acmFormatTagEnumW.argtypes = [
    wintypes.HANDLE,  # had : HACMDRIVER
    ctypes.c_void_p,  # paftd : ACMFORMATTAGDETAILSW* in/out
    ctypes.c_void_p,  # fnCallback : ACMFORMATTAGENUMCBW
    ctypes.c_size_t,  # dwInstance : UINT_PTR
    wintypes.DWORD,  # fdwEnum : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmFormatTagEnumW = Fiddle::Function.new(
  lib['acmFormatTagEnumW'],
  [
    Fiddle::TYPE_VOIDP,  # had : HACMDRIVER
    Fiddle::TYPE_VOIDP,  # paftd : ACMFORMATTAGDETAILSW* in/out
    Fiddle::TYPE_VOIDP,  # fnCallback : ACMFORMATTAGENUMCBW
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR
    -Fiddle::TYPE_INT,  # fdwEnum : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msacm32")]
extern "system" {
    fn acmFormatTagEnumW(
        had: *mut core::ffi::c_void,  // HACMDRIVER
        paftd: *mut ACMFORMATTAGDETAILSW,  // ACMFORMATTAGDETAILSW* in/out
        fnCallback: *const core::ffi::c_void,  // ACMFORMATTAGENUMCBW
        dwInstance: usize,  // UINT_PTR
        fdwEnum: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("MSACM32.dll", CharSet = CharSet.Unicode)]
public static extern uint acmFormatTagEnumW(IntPtr had, IntPtr paftd, IntPtr fnCallback, UIntPtr dwInstance, uint fdwEnum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSACM32_acmFormatTagEnumW' -Namespace Win32 -PassThru
# $api::acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
#uselib "MSACM32.dll"
#func global acmFormatTagEnumW "acmFormatTagEnumW" wptr, wptr, wptr, wptr, wptr
; acmFormatTagEnumW had, varptr(paftd), fnCallback, dwInstance, fdwEnum   ; 戻り値は stat
; had : HACMDRIVER -> "wptr"
; paftd : ACMFORMATTAGDETAILSW* in/out -> "wptr"
; fnCallback : ACMFORMATTAGENUMCBW -> "wptr"
; dwInstance : UINT_PTR -> "wptr"
; fdwEnum : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "MSACM32.dll"
#cfunc global acmFormatTagEnumW "acmFormatTagEnumW" sptr, var, sptr, sptr, int
; res = acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
; had : HACMDRIVER -> "sptr"
; paftd : ACMFORMATTAGDETAILSW* in/out -> "var"
; fnCallback : ACMFORMATTAGENUMCBW -> "sptr"
; dwInstance : UINT_PTR -> "sptr"
; fdwEnum : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD acmFormatTagEnumW(HACMDRIVER had, ACMFORMATTAGDETAILSW* paftd, ACMFORMATTAGENUMCBW fnCallback, UINT_PTR dwInstance, DWORD fdwEnum)
#uselib "MSACM32.dll"
#cfunc global acmFormatTagEnumW "acmFormatTagEnumW" intptr, var, intptr, intptr, int
; res = acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
; had : HACMDRIVER -> "intptr"
; paftd : ACMFORMATTAGDETAILSW* in/out -> "var"
; fnCallback : ACMFORMATTAGENUMCBW -> "intptr"
; dwInstance : UINT_PTR -> "intptr"
; fdwEnum : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msacm32 = windows.NewLazySystemDLL("MSACM32.dll")
	procacmFormatTagEnumW = msacm32.NewProc("acmFormatTagEnumW")
)

// had (HACMDRIVER), paftd (ACMFORMATTAGDETAILSW* in/out), fnCallback (ACMFORMATTAGENUMCBW), dwInstance (UINT_PTR), fdwEnum (DWORD)
r1, _, err := procacmFormatTagEnumW.Call(
	uintptr(had),
	uintptr(paftd),
	uintptr(fnCallback),
	uintptr(dwInstance),
	uintptr(fdwEnum),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function acmFormatTagEnumW(
  had: THandle;   // HACMDRIVER
  paftd: Pointer;   // ACMFORMATTAGDETAILSW* in/out
  fnCallback: Pointer;   // ACMFORMATTAGENUMCBW
  dwInstance: NativeUInt;   // UINT_PTR
  fdwEnum: DWORD   // DWORD
): DWORD; stdcall;
  external 'MSACM32.dll' name 'acmFormatTagEnumW';
result := DllCall("MSACM32\acmFormatTagEnumW"
    , "Ptr", had   ; HACMDRIVER
    , "Ptr", paftd   ; ACMFORMATTAGDETAILSW* in/out
    , "Ptr", fnCallback   ; ACMFORMATTAGENUMCBW
    , "UPtr", dwInstance   ; UINT_PTR
    , "UInt", fdwEnum   ; DWORD
    , "UInt")   ; return: DWORD
●acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum) = DLL("MSACM32.dll", "dword acmFormatTagEnumW(void*, void*, void*, int, dword)")
# 呼び出し: acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
# had : HACMDRIVER -> "void*"
# paftd : ACMFORMATTAGDETAILSW* in/out -> "void*"
# fnCallback : ACMFORMATTAGENUMCBW -> "void*"
# dwInstance : UINT_PTR -> "int"
# fdwEnum : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msacm32" fn acmFormatTagEnumW(
    had: ?*anyopaque, // HACMDRIVER
    paftd: [*c]ACMFORMATTAGDETAILSW, // ACMFORMATTAGDETAILSW* in/out
    fnCallback: ?*anyopaque, // ACMFORMATTAGENUMCBW
    dwInstance: usize, // UINT_PTR
    fdwEnum: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc acmFormatTagEnumW(
    had: pointer,  # HACMDRIVER
    paftd: ptr ACMFORMATTAGDETAILSW,  # ACMFORMATTAGDETAILSW* in/out
    fnCallback: pointer,  # ACMFORMATTAGENUMCBW
    dwInstance: uint,  # UINT_PTR
    fdwEnum: uint32  # DWORD
): uint32 {.importc: "acmFormatTagEnumW", stdcall, dynlib: "MSACM32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msacm32");
extern(Windows)
uint acmFormatTagEnumW(
    void* had,   // HACMDRIVER
    ACMFORMATTAGDETAILSW* paftd,   // ACMFORMATTAGDETAILSW* in/out
    void* fnCallback,   // ACMFORMATTAGENUMCBW
    size_t dwInstance,   // UINT_PTR
    uint fdwEnum   // DWORD
);
ccall((:acmFormatTagEnumW, "MSACM32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{ACMFORMATTAGDETAILSW}, Ptr{Cvoid}, Csize_t, UInt32),
      had, paftd, fnCallback, dwInstance, fdwEnum)
# had : HACMDRIVER -> Ptr{Cvoid}
# paftd : ACMFORMATTAGDETAILSW* in/out -> Ptr{ACMFORMATTAGDETAILSW}
# fnCallback : ACMFORMATTAGENUMCBW -> Ptr{Cvoid}
# dwInstance : UINT_PTR -> Csize_t
# fdwEnum : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t acmFormatTagEnumW(
    void* had,
    void* paftd,
    void* fnCallback,
    uintptr_t dwInstance,
    uint32_t fdwEnum);
]]
local msacm32 = ffi.load("msacm32")
-- msacm32.acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
-- had : HACMDRIVER
-- paftd : ACMFORMATTAGDETAILSW* in/out
-- fnCallback : ACMFORMATTAGENUMCBW
-- dwInstance : UINT_PTR
-- fdwEnum : 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('MSACM32.dll');
const acmFormatTagEnumW = lib.func('__stdcall', 'acmFormatTagEnumW', 'uint32_t', ['void *', 'void *', 'void *', 'uintptr_t', 'uint32_t']);
// acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
// had : HACMDRIVER -> 'void *'
// paftd : ACMFORMATTAGDETAILSW* in/out -> 'void *'
// fnCallback : ACMFORMATTAGENUMCBW -> 'void *'
// dwInstance : UINT_PTR -> 'uintptr_t'
// fdwEnum : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
// コールバック(関数ポインタ)は koffi.proto/koffi.register で型を定義して渡す(素の void* では JS 関数を渡せない)。
const lib = Deno.dlopen("MSACM32.dll", {
  acmFormatTagEnumW: { parameters: ["pointer", "pointer", "pointer", "usize", "u32"], result: "u32" },
});
// lib.symbols.acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum)
// had : HACMDRIVER -> "pointer"
// paftd : ACMFORMATTAGDETAILSW* in/out -> "pointer"
// fnCallback : ACMFORMATTAGENUMCBW -> "pointer"
// dwInstance : UINT_PTR -> "usize"
// fdwEnum : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t acmFormatTagEnumW(
    void* had,
    void* paftd,
    void* fnCallback,
    size_t dwInstance,
    uint32_t fdwEnum);
C, "MSACM32.dll");
// $ffi->acmFormatTagEnumW(had, paftd, fnCallback, dwInstance, fdwEnum);
// had : HACMDRIVER
// paftd : ACMFORMATTAGDETAILSW* in/out
// fnCallback : ACMFORMATTAGENUMCBW
// dwInstance : UINT_PTR
// fdwEnum : 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 Msacm32 extends StdCallLibrary {
    Msacm32 INSTANCE = Native.load("msacm32", Msacm32.class, W32APIOptions.UNICODE_OPTIONS);
    int acmFormatTagEnumW(
        Pointer had,   // HACMDRIVER
        Pointer paftd,   // ACMFORMATTAGDETAILSW* in/out
        Callback fnCallback,   // ACMFORMATTAGENUMCBW
        long dwInstance,   // UINT_PTR
        int fdwEnum   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msacm32")]
lib LibMSACM32
  fun acmFormatTagEnumW = acmFormatTagEnumW(
    had : Void*,   # HACMDRIVER
    paftd : ACMFORMATTAGDETAILSW*,   # ACMFORMATTAGDETAILSW* in/out
    fnCallback : Void*,   # ACMFORMATTAGENUMCBW
    dwInstance : LibC::SizeT,   # UINT_PTR
    fdwEnum : 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 acmFormatTagEnumWNative = Uint32 Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, UintPtr, Uint32);
typedef acmFormatTagEnumWDart = int Function(Pointer<Void>, Pointer<Void>, Pointer<Void>, int, int);
final acmFormatTagEnumW = DynamicLibrary.open('MSACM32.dll')
    .lookupFunction<acmFormatTagEnumWNative, acmFormatTagEnumWDart>('acmFormatTagEnumW');
// had : HACMDRIVER -> Pointer<Void>
// paftd : ACMFORMATTAGDETAILSW* in/out -> Pointer<Void>
// fnCallback : ACMFORMATTAGENUMCBW -> Pointer<Void>
// dwInstance : UINT_PTR -> UintPtr
// fdwEnum : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function acmFormatTagEnumW(
  had: THandle;   // HACMDRIVER
  paftd: Pointer;   // ACMFORMATTAGDETAILSW* in/out
  fnCallback: Pointer;   // ACMFORMATTAGENUMCBW
  dwInstance: NativeUInt;   // UINT_PTR
  fdwEnum: DWORD   // DWORD
): DWORD; stdcall;
  external 'MSACM32.dll' name 'acmFormatTagEnumW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "acmFormatTagEnumW"
  c_acmFormatTagEnumW :: Ptr () -> Ptr () -> Ptr () -> CUIntPtr -> Word32 -> IO Word32
-- had : HACMDRIVER -> Ptr ()
-- paftd : ACMFORMATTAGDETAILSW* in/out -> Ptr ()
-- fnCallback : ACMFORMATTAGENUMCBW -> Ptr ()
-- dwInstance : UINT_PTR -> CUIntPtr
-- fdwEnum : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let acmformattagenumw =
  foreign "acmFormatTagEnumW"
    ((ptr void) @-> (ptr void) @-> (ptr void) @-> size_t @-> uint32_t @-> returning uint32_t)
(* had : HACMDRIVER -> (ptr void) *)
(* paftd : ACMFORMATTAGDETAILSW* in/out -> (ptr void) *)
(* fnCallback : ACMFORMATTAGENUMCBW -> (ptr void) *)
(* dwInstance : UINT_PTR -> size_t *)
(* fdwEnum : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msacm32 (t "MSACM32.dll"))
(cffi:use-foreign-library msacm32)

(cffi:defcfun ("acmFormatTagEnumW" acm-format-tag-enum-w :convention :stdcall) :uint32
  (had :pointer)   ; HACMDRIVER
  (paftd :pointer)   ; ACMFORMATTAGDETAILSW* in/out
  (fn-callback :pointer)   ; ACMFORMATTAGENUMCBW
  (dw-instance :uint64)   ; UINT_PTR
  (fdw-enum :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $acmFormatTagEnumW = Win32::API::More->new('MSACM32',
    'DWORD acmFormatTagEnumW(HANDLE had, LPVOID paftd, LPVOID fnCallback, WPARAM dwInstance, DWORD fdwEnum)');
# my $ret = $acmFormatTagEnumW->Call($had, $paftd, $fnCallback, $dwInstance, $fdwEnum);
# had : HACMDRIVER -> HANDLE
# paftd : ACMFORMATTAGDETAILSW* in/out -> LPVOID
# fnCallback : ACMFORMATTAGENUMCBW -> LPVOID
# dwInstance : UINT_PTR -> WPARAM
# fdwEnum : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# コールバック(関数ポインタ)は Perl sub を直接渡せません。Win32::API::Callback を使用してください。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型