acmFormatDetailsW

関数

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

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

シグネチャ

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

DWORD acmFormatDetailsW(
    HACMDRIVER had,
    tACMFORMATDETAILSW* pafd,
    DWORD fdwDetails
);

パラメーター

名前

型

方向

説明

had

HACMDRIVER

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

pafd

tACMFORMATDETAILSW*

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 (Unicode) 関数は、特定の波形オーディオフォーマットタグに関するフォーマットの詳細を ACM に問い合わせます。(acmFormatDetailsW)

戻り値

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

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

解説(Remarks)

メモ

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

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

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

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

' had : HACMDRIVER
' pafd : tACMFORMATDETAILSW* in/out
' fdwDetails : DWORD
Declare PtrSafe Function acmFormatDetailsW Lib "msacm32" ( _
    ByVal had As LongPtr, _
    ByVal pafd As LongPtr, _
    ByVal fdwDetails 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

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('MSACM32.dll')
acmFormatDetailsW = Fiddle::Function.new(
  lib['acmFormatDetailsW'],
  [
    Fiddle::TYPE_VOIDP,  # had : HACMDRIVER
    Fiddle::TYPE_VOIDP,  # pafd : tACMFORMATDETAILSW* in/out
    -Fiddle::TYPE_INT,  # fdwDetails : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

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

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

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

出力引数:

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