acmFormatDetailsA

関数

ACMの波形フォーマットの詳細情報をANSI文字列で取得する。

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

シグネチャ

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

DWORD acmFormatDetailsA(
    HACMDRIVER had,
    ACMFORMATDETAILSA* pafd,
    DWORD fdwDetails
);

パラメーター

名前

型

方向

説明

had

HACMDRIVER

フォーマットタグの波形音声フォーマットの詳細を問い合わせる ACM ドライバーのハンドル。このパラメーターが NULL の場合、ACM は最初に見つかった適切な ACM ドライバーの詳細情報を使用します。

pafd

ACMFORMATDETAILSA*

inout

指定したフォーマットタグのフォーマット詳細を格納する ACMFORMATDETAILS 構造体へのポインター。

fdwDetails

DWORD

波形音声フォーマットタグの詳細を取得するためのフラグ。次の値が定義されています。

[ACMFORMATDETAILS](./nf-msacm-acmformatdetails.md) 構造体が指定され、残りの詳細を返す必要があります。ACMFORMATDETAILS 構造体の dwFormatTag メンバーは、pwfx が指定するフォーマットタグと同じ値に初期化されている必要があります。このクエリの種類は、任意のフォーマット構造体に関する文字列の説明を取得するために使用できます。アプリケーションが had に ACM ドライバーハンドルを指定した場合、そのドライバーに対するフォーマットの詳細が返されます。アプリケーションが had に NULL を指定した場合、ACM は詳細を返すのに適した最初のドライバーを見つけます。

値

意味

ACM_FORMATDETAILSF_FORMAT

ACM_FORMATDETAILSF_INDEX

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

戻り値の型: DWORD

公式ドキュメント

acmFormatDetails 関数は、特定の波形音声フォーマットタグに関するフォーマットの詳細情報を ACM に問い合わせます。(acmFormatDetailsA)

戻り値

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

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

解説(Remarks)

メモ

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

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

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

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

' had : HACMDRIVER
' pafd : ACMFORMATDETAILSA* in/out
' fdwDetails : DWORD
Declare PtrSafe Function acmFormatDetailsA 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

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

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "msacm32")]
extern "system" {
    fn acmFormatDetailsA(
        had: *mut core::ffi::c_void,  // HACMDRIVER
        pafd: *mut ACMFORMATDETAILSA,  // ACMFORMATDETAILSA* 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 acmFormatDetailsA(IntPtr had, IntPtr pafd, uint fdwDetails);
"@
$api = Add-Type -MemberDefinition $sig -Name 'MSACM32_acmFormatDetailsA' -Namespace Win32 -PassThru
# $api::acmFormatDetailsA(had, pafd, fdwDetails)

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

出力引数:

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