acmFilterDetailsA

関数

ACMの波形フィルターの詳細情報をANSI文字列で取得する。

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

シグネチャ

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

DWORD acmFilterDetailsA(
    HACMDRIVER had,
    ACMFILTERDETAILSA* pafd,
    DWORD fdwDetails
);

パラメーター

名前

型

方向

説明

had

HACMDRIVER

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

pafd

ACMFILTERDETAILSA*

inout

指定されたフィルタータグのフィルター詳細を受け取る ACMFILTERDETAILS 構造体へのポインター。

fdwDetails

DWORD

詳細を取得するためのフラグ。次の値が定義されています。

[ACMFILTERDETAILS](./nf-msacm-acmfilterdetails.md) 構造体が指定されており、残りの詳細を返す必要があります。ACMFILTERDETAILS 構造体の dwFilterTag メンバーは、pwfltr が指定するフィルタータグと同じ値に初期化する必要があります。このクエリタイプは、任意のフィルター構造体の文字列による説明を取得するために使用できます。アプリケーションが had に ACM ドライバーハンドルを指定した場合、そのドライバーのフィルター詳細が返されます。アプリケーションが had に NULL を指定した場合、ACM は詳細を返すために最初に見つかった適切なドライバーを使用します。

値

意味

ACM_FILTERDETAILSF_FILTER

ACM_FILTERDETAILSF_INDEX

フィルタータグに対するフィルターインデックスが ACMFILTERDETAILS 構造体の dwFilterIndex メンバーで指定されています。フィルター詳細は pafd で定義された構造体に返されます。インデックスの範囲は 0 から、フィルタータグに対して ACMFILTERTAGDETAILS 構造体で返される cStandardFilters メンバーの値より 1 小さい値までです。このフラグでフィルター詳細を取得する場合、アプリケーションは had にドライバーハンドルを指定する必要があります。この関数を呼び出す前に初期化すべきメンバーについては、ACMFILTERDETAILS 構造体を参照してください。

戻り値の型: DWORD

公式ドキュメント

acmFilterDetails 関数は、特定のウェーブフォームオーディオフィルタータグを持つフィルターの詳細を ACM に問い合わせます。(acmFilterDetailsA)

戻り値

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

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 acmFilterDetailsA(
    HACMDRIVER had,
    ACMFILTERDETAILSA* pafd,
    DWORD fdwDetails
);

[DllImport("MSACM32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint acmFilterDetailsA(
    IntPtr had,   // HACMDRIVER
    IntPtr pafd,   // ACMFILTERDETAILSA* in/out
    uint fdwDetails   // DWORD
);

<DllImport("MSACM32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function acmFilterDetailsA(
    had As IntPtr,   ' HACMDRIVER
    pafd As IntPtr,   ' ACMFILTERDETAILSA* in/out
    fdwDetails As UInteger   ' DWORD
) As UInteger
End Function

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

import ctypes
from ctypes import wintypes

acmFilterDetailsA = ctypes.windll.msacm32.acmFilterDetailsA
acmFilterDetailsA.restype = wintypes.DWORD
acmFilterDetailsA.argtypes = [
    wintypes.HANDLE,  # had : HACMDRIVER
    ctypes.c_void_p,  # pafd : ACMFILTERDETAILSA* in/out
    wintypes.DWORD,  # fdwDetails : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmFilterDetailsA = Fiddle::Function.new(
  lib['acmFilterDetailsA'],
  [
    Fiddle::TYPE_VOIDP,  # had : HACMDRIVER
    Fiddle::TYPE_VOIDP,  # pafd : ACMFILTERDETAILSA* in/out
    -Fiddle::TYPE_INT,  # fdwDetails : DWORD
  ],
  -Fiddle::TYPE_INT)

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

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

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

出力引数:

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