acmFilterEnumA

関数

利用可能な波形フィルターを列挙しコールバックへ通知する。ANSI版。

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

シグネチャ

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

DWORD acmFilterEnumA(
    HACMDRIVER had,
    ACMFILTERDETAILSA* pafd,
    ACMFILTERENUMCBA fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

パラメーター

名前

型

方向

説明

had

HACMDRIVER

波形オーディオフィルターの詳細を問い合わせる ACM ドライバーへのハンドル。このパラメーターが NULL の場合、ACM は最初に見つかった適切な ACM ドライバーの詳細を使用します。

pafd

ACMFILTERDETAILSA*

inout

fnCallback で指定した関数に渡される際に、フィルターの詳細を格納する ACMFILTERDETAILS 構造体へのポインター。アプリケーションが acmFilterEnum を呼び出すときは、この構造体の cbStruct、pwfltr、cbwfltr の各メンバーを初期化しておく必要があります。また、dwFilterTag メンバーも WAVE_FILTER_UNKNOWN または有効なフィルタータグのいずれかに初期化しておく必要があります。

fnCallback

ACMFILTERENUMCBA

アプリケーション定義のコールバック関数のプロシージャインスタンスアドレス。

dwInstance

UINT_PTR

ACM フィルターの詳細とともにコールバック関数に渡される、アプリケーション定義の 32 ビット (DWORD) または 64 ビット (DWORD_PTR) の値。

fdwEnum

DWORD

指定したフィルタータグのフィルターを列挙するためのフラグ。次の値が定義されています。

[ACMFILTERDETAILS](./nf-msacm-acmfilterdetails.md) 構造体の dwFilterTag メンバーが有効です。列挙では、この属性に一致するフィルターのみが列挙されます。ACMFILTERDETAILS 構造体の dwFilterTag メンバーは、WAVEFILTER 構造体の dwFilterTag メンバーと等しい必要があります。

値	意味
ACM_FILTERENUMF_DWFILTERTAG

戻り値の型: DWORD

公式ドキュメント

acmFilterEnum 関数は、ACM ドライバーから、指定したフィルタータグに対して利用可能な波形オーディオフィルターを列挙します。この関数は、フィルタータグに適したフィルターがなくなるか、コールバック関数が FALSE を返すまで列挙を続けます。(acmFilterEnumA)

戻り値

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

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

解説(Remarks)

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

コールバック関数の内部から次の関数を呼び出してはいけません。acmDriverAdd、acmDriverRemove、acmDriverPriority。

メモ

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

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

各言語での呼び出し定義

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

DWORD acmFilterEnumA(
    HACMDRIVER had,
    ACMFILTERDETAILSA* pafd,
    ACMFILTERENUMCBA fnCallback,
    UINT_PTR dwInstance,
    DWORD fdwEnum
);

[DllImport("MSACM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint acmFilterEnumA(
    IntPtr had,   // HACMDRIVER
    IntPtr pafd,   // ACMFILTERDETAILSA* in/out
    IntPtr fnCallback,   // ACMFILTERENUMCBA
    UIntPtr dwInstance,   // UINT_PTR
    uint fdwEnum   // DWORD
);

<DllImport("MSACM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function acmFilterEnumA(
    had As IntPtr,   ' HACMDRIVER
    pafd As IntPtr,   ' ACMFILTERDETAILSA* in/out
    fnCallback As IntPtr,   ' ACMFILTERENUMCBA
    dwInstance As UIntPtr,   ' UINT_PTR
    fdwEnum As UInteger   ' DWORD
) As UInteger
End Function

' had : HACMDRIVER
' pafd : ACMFILTERDETAILSA* in/out
' fnCallback : ACMFILTERENUMCBA
' dwInstance : UINT_PTR
' fdwEnum : DWORD
Declare PtrSafe Function acmFilterEnumA Lib "msacm32" ( _
    ByVal had As LongPtr, _
    ByVal pafd As LongPtr, _
    ByVal fnCallback As LongPtr, _
    ByVal dwInstance As LongPtr, _
    ByVal fdwEnum As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

acmFilterEnumA = ctypes.windll.msacm32.acmFilterEnumA
acmFilterEnumA.restype = wintypes.DWORD
acmFilterEnumA.argtypes = [
    wintypes.HANDLE,  # had : HACMDRIVER
    ctypes.c_void_p,  # pafd : ACMFILTERDETAILSA* in/out
    ctypes.c_void_p,  # fnCallback : ACMFILTERENUMCBA
    ctypes.c_size_t,  # dwInstance : UINT_PTR
    wintypes.DWORD,  # fdwEnum : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmFilterEnumA = Fiddle::Function.new(
  lib['acmFilterEnumA'],
  [
    Fiddle::TYPE_VOIDP,  # had : HACMDRIVER
    Fiddle::TYPE_VOIDP,  # pafd : ACMFILTERDETAILSA* in/out
    Fiddle::TYPE_VOIDP,  # fnCallback : ACMFILTERENUMCBA
    Fiddle::TYPE_UINTPTR_T,  # dwInstance : UINT_PTR
    -Fiddle::TYPE_INT,  # fdwEnum : DWORD
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msacm32")]
extern "system" {
    fn acmFilterEnumA(
        had: *mut core::ffi::c_void,  // HACMDRIVER
        pafd: *mut ACMFILTERDETAILSA,  // ACMFILTERDETAILSA* in/out
        fnCallback: *const core::ffi::c_void,  // ACMFILTERENUMCBA
        dwInstance: usize,  // UINT_PTR
        fdwEnum: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("MSACM32.dll", CharSet = CharSet.Ansi)]
public static extern uint acmFilterEnumA(IntPtr had, IntPtr pafd, IntPtr fnCallback, UIntPtr dwInstance, uint fdwEnum);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSACM32_acmFilterEnumA' -Namespace Win32 -PassThru
# $api::acmFilterEnumA(had, pafd, fnCallback, dwInstance, fdwEnum)

#uselib "MSACM32.dll"
#func global acmFilterEnumA "acmFilterEnumA" sptr, sptr, sptr, sptr, sptr
; acmFilterEnumA had, varptr(pafd), fnCallback, dwInstance, fdwEnum   ; 戻り値は stat
; had : HACMDRIVER -> "sptr"
; pafd : ACMFILTERDETAILSA* in/out -> "sptr"
; fnCallback : ACMFILTERENUMCBA -> "sptr"
; dwInstance : UINT_PTR -> "sptr"
; fdwEnum : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "MSACM32.dll"
#cfunc global acmFilterEnumA "acmFilterEnumA" sptr, var, sptr, sptr, int
; res = acmFilterEnumA(had, pafd, fnCallback, dwInstance, fdwEnum)
; had : HACMDRIVER -> "sptr"
; pafd : ACMFILTERDETAILSA* in/out -> "var"
; fnCallback : ACMFILTERENUMCBA -> "sptr"
; dwInstance : UINT_PTR -> "sptr"
; fdwEnum : DWORD -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "MSACM32.dll"
#cfunc global acmFilterEnumA "acmFilterEnumA" sptr, sptr, sptr, sptr, int
; res = acmFilterEnumA(had, varptr(pafd), fnCallback, dwInstance, fdwEnum)
; had : HACMDRIVER -> "sptr"
; pafd : ACMFILTERDETAILSA* in/out -> "sptr"
; fnCallback : ACMFILTERENUMCBA -> "sptr"
; dwInstance : UINT_PTR -> "sptr"
; fdwEnum : DWORD -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。