acmFormatTagDetailsA function (msacm.h)

Article
02/09/2023

The acmFormatTagDetails function queries the ACM for details on a specific waveform-audio format tag.

Syntax

MMRESULT ACMAPI acmFormatTagDetailsA(
  HACMDRIVER             had,
  LPACMFORMATTAGDETAILSA paftd,
  DWORD                  fdwDetails
);

Parameters

had

Handle to the ACM driver to query for waveform-audio format tag details. If this parameter is NULL, the ACM uses the details from the first suitable ACM driver. An application must specify a valid handle or driver identifier when using the ACM_FORMATTAGDETAILSF_INDEX query type. Driver identifiers for disabled drivers are not allowed.

paftd

Pointer to the ACMFORMATTAGDETAILS structure that is to receive the format tag details.

fdwDetails

Flags for getting the details. The following values are defined.

[ACMFORMATTAGDETAILS](./nf-msacm-acmformattagdetails.md) structure. The format tag details will be returned in the structure pointed to by paftd. If an application specifies an ACM driver handle for had, details on the format tag will be returned for that driver. If an application specifies NULL for had, the ACM finds the first acceptable driver to return the details. [ACMDRIVERDETAILS](./nf-msacm-acmdriverdetails.md) structure for an ACM driver. An application must specify a driver handle for had when retrieving format tag details with this flag. [ACMFORMATTAGDETAILS](./nf-msacm-acmformattagdetails.md) structure must either be WAVE_FORMAT_UNKNOWN or the format tag to find the largest size for. If an application specifies an ACM driver handle for had, details on the largest format tag will be returned for that driver. If an application specifies NULL for had, the ACM finds an acceptable driver with the largest format tag requested to return the details.

Value	Meaning
ACM_FORMATTAGDETAILSF_FORMATTAG
ACM_FORMATTAGDETAILSF_INDEX
ACM_FORMATTAGDETAILSF_LARGESTSIZE

Return value

Returns zero if successful or an error otherwise. Possible error values include the following.

Return code	Description
ACMERR_NOTPOSSIBLE	The details requested are not available.
MMSYSERR_INVALFLAG	At least one flag is invalid.
MMSYSERR_INVALHANDLE	The specified handle is invalid.
MMSYSERR_INVALPARAM	At least one parameter is invalid.

Remarks

Note

The msacm.h header defines ACMFORMATTAGDETAILS as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	msacm.h
Library	Msacm32.lib
DLL	Msacm32.dll