waveOutGetDevCaps(3mms) — Subroutines
Name
waveOutGetDevCaps --- Query the specified waveform audio output device to determine its capabilities
Syntax
#include <mme/mme_api.h>
MMRESULT waveOutGetDevCaps(UINT uDeviceID,
LPWAVEOUTCAPS lpCaps,
UINT uSize);
Arguments
UINT uDeviceID
Identifies the waveform audio output device to query. Use a valid waveform audio output device ID (see the Comments section) or the WAVE_MAPPER constant. If a wave mapper is not installed, the function returns an error code.
LPWAVEOUTCAPS lpCaps
Specifies a pointer to a WAVEOUTCAPS data structure. This data structure is filled with information about the capabilities of the device.
The WAVEOUTCAPS data structure must be allocated with the mmeAllocMem function before being passed to the waveOutGetDevCaps function.
See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures.
UINT uSize
Specifies the size of the WAVEOUTCAPS data structure.
Description
The waveOutGetDevCaps function queries the specified waveform audio output device to determine its capabilities. The device ID specified by the uDeviceID argument varies from zero to one fewer than the number of devices present. Use the waveOutGetNumDevs function to determine the number of waveform output devices present in the system.
Only uSize bytes (or fewer) of information is copied to the location pointed to by the lpCaps argument. If uSize is zero, nothing is copied and the function returns the MMSYSERR_NOERROR error code.
Extensions
The WAVEOUTCAPS data structure has been extended to support an 8-bit mono MULAW at 8 kHz waveform audio format. The WAVE_FORMAT_08M08_MULAW format identifier is a Digital extension to the API specification to support the built-in audio capabilities of Alpha AXP workstations.
Return Values
Returns MMSYSERR_NOERROR if the function is successful; otherwise, it returns one of the following error codes:
MMSYSERR_BADDEVICEID@T{ The specified device ID is out of range. T} MMSYSERR_NODRIVER@T{ No waveOut driver is installed. T} MMSYSERR_INVALPARAM@T{ The size of the WAVEOUTCAPS data structure is invalid. T}