auxGetDevCapsA function (mmeapi.h)

Article
02/22/2024

The auxGetDevCaps function retrieves the capabilities of a given auxiliary output device.

Syntax

MMRESULT auxGetDevCapsA(
  UINT_PTR   uDeviceID,
  LPAUXCAPSA pac,
  UINT       cbac
);

Parameters

uDeviceID

Identifier of the auxiliary output device to be queried. Specify a valid device identifier (see the following comments section), or use the following constant:

Value	Meaning
AUX_MAPPER	Auxiliary audio mapper. The function returns an error if no auxiliary audio mapper is installed.

pac

Pointer to an AUXCAPS structure to be filled with information about the capabilities of the device.

cbac

Size, in bytes, of the AUXCAPS structure.

Return value

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

Return code	Description
MMSYSERR_BADDEVICEID	Specified device identifier is out of range.

Remarks

The device identifier in uDeviceID varies from zero to one less than the number of devices present. AUX_MAPPER may also be used. Use the auxGetNumDevs function to determine the number of auxiliary output devices present in the system.

Note

The mmeapi.h header defines auxGetDevCaps 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	mmeapi.h (include Windows.h)
Library	Winmm.lib
DLL	Winmm.dll