Export (0) Print
Expand All
Expand Minimize

acmFilterTagDetails function

The acmFilterTagDetails function queries the ACM for details about a specific waveform-audio filter tag.

Syntax


MMRESULT acmFilterTagDetails(
  HACMDRIVER had,
  LPACMFILTERTAGDETAILS paftd,
  DWORD_PTR fdwDetails
);

Parameters

had

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

paftd

Pointer to the ACMFILTERTAGDETAILS structure that is to receive the filter tag details.

fdwDetails

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

Value Meaning
ACM_FILTERTAGDETAILSF_FILTERTAGA filter tag was given in the dwFilterTag member of the ACMFILTERTAGDETAILS structure. The filter 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 filter 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_FILTERTAGDETAILSF_INDEXA filter tag index was given in the dwFilterTagIndex member of the ACMFILTERTAGDETAILS structure. The filter tag and details will be returned in the structure pointed to by paftd. The index ranges from zero to one less than the cFilterTags member returned in the ACMDRIVERDETAILS structure for an ACM driver. An application must specify a driver handle for had when retrieving filter tag details with this flag.
ACM_FILTERTAGDETAILSF_LARGESTSIZEDetails on the filter tag with the largest filter size, in bytes, are to be returned. The dwFilterTag member must either be WAVE_FILTER_UNKNOWN or the filter tag to find the largest size for. If an application specifies an ACM driver handle for had, details on the largest filter tag will be returned for that driver. If an application specifies NULL for had, the ACM finds an acceptable driver with the largest filter tag requested to return the details.

 

Return value

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

Return codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Msacm.h

Library

Msacm32.lib

DLL

Msacm32.dll

Unicode and ANSI names

acmFilterTagDetailsW (Unicode) and acmFilterTagDetailsA (ANSI)

See also

Audio Compression Manager
Audio Compression Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft