waveOutGetFormatInfo(3mms) — Subroutines
Name
waveOutGetFormatInfo --- Query the specified waveform audio output device to determine high-level information relating to all supported formats
Syntax
#include <mme/mme_api.h>
MMRESULT waveOutGetFormatInfo (UINT uClassDeviceID,
LPWAVEFORMATINFO lpWaveformatInfo);
Arguments
UINT uClassDeviceID
Identifies the waveform audio output device.
LPWAVEFORMATINFO lpWaveformatInfo
Specifies a pointer to a WAVEFORMATINFO data structure. The waveOutGetFormatInfo function returns high-level information common to all formats supported by the device in this data structure.
The WAVEFORMATINFO data structure must be allocated with the mmeAllocMem function before being passed to the waveOutGetFormatInfo function. See the mmeAllocMem(3mms) reference page for more information about allocating memory for data structures.
Description
The waveOutGetFormatInfo function queries the specified waveform audio output device to determine its capabilities. Information is returned relating to all formats supported by the device, not just standard formats. See the dwFormats description in Chapter 3 of the Programmer’s Guide for a list of standard formats. The information returned includes the number of formats supported, the maximum size of a WAVEFORMATEX data structure needed to describe any supported format, and the maximum size of an ascii string needed to provide a text description of any supported format.
The device ID specified by the uClassDeviceID argument varies from zero to one less than the number of audio devices present.
Extensions
The waveOutGetFormatInfo function is a Digital extension to the Microsoft multimedia API specification.
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 is invalid. T} MMSYSERR_INVALPARAM@T{ The parameter lpWaveformatInfo is NULL. The value of the cbStruct field within the parameter lpWaveformatInfo is invalid. The parameter lpWaveformatInfo is not allocated from shared memory. T} MMSYSERR_NODRIVER@T{ A waveOut driver is not installed. T}