acmFormatTagDetails

Article
12/10/2007

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

MMRESULT acmFormatTagDetails(
  HACMDRIVER had,               
  LPACMFORMATTAGDETAILS 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.

Value	Meaning
ACM_FORMATTAGDETAILSF_FORMATTAG	A format tag was given in the dwFormatTag member of the ACMFORMATTAGDETAILS 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.
ACM_FORMATTAGDETAILSF_INDEX	A format tag index was given in the dwFormatTagIndex member of the ACMFORMATTAGDETAILS structure. The format tag and details will be returned in the structure defined by paftd. The index ranges from zero to one less than the cFormatTags member returned in the ACMDRIVERDETAILS structure for an ACM driver. An application must specify a driver handle for had when retrieving format tag details with this flag.
ACM_FORMATTAGDETAILSF_LARGESTSIZE	Details on the format tag with the largest format size, in bytes, are to be returned. The dwFormatTag member of the ACMFORMATTAGDETAILS 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.

Return Values

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

Value	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.

Requirements

**  Windows NT/2000/XP:** Included in Windows NT 3.1 and later.
**  Windows 95/98/Me:** Included in Windows 95 and later.
**  Header:** Declared in Msacm.h.
**  Library:** Use Msacm32.lib.
**  Unicode:** Implemented as Unicode and ANSI versions on Windows NT/2000/XP.

acmFormatTagDetails

Additional resources