waveOutGetProperty

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This function queries the value of a specific property in a property set for waveform audio output.

Syntax

MMRESULT waveOutGetProperty(
  UINT        uDeviceID,
  const GUID* pPropSetId,
  ULONG       ulPropId,
  LPVOID      pvPropParams,
  ULONG       cbPropParams,
  LPVOID      pvPropData,
  ULONG       cbPropData,
  PULONG      pcbReturn
);

Parameters

• uDeviceID,
  [in] A UINT value that identifies the audio device that you want to query for properties. This value can either be a device ID for the audio device, or an HWAVEIN or HWAVEOUT handle to an audio stream. If there is only one audio device present, its device ID is 0. To query the MM_PROPSET_GAINCLASS_CLASS property set, this parameter must be 0.

• pPropSetId,
  [in] A pointer to a GUID that represents the property set you want to query. (You can use your own GUIDs to define your own property sets.) Properties on a stream or device are grouped into sets. The following table shows the predefined property sets.

  Property set	Description
  MM_PROPSET_GAINCLASS_CLASS	The general property set for all audio gain class properties.
  MM_PROPSET_GAINCLASS_STREAM	A property set for properties specific to audio streams.

• ulPropId,
  [in] A ULONG value that is an index to identify a specific property within a property set. The following table shows the properties available for the predefined property sets.

  Property set	Property	Property Description
  MM_PROPSET_GAINCLASS_CLASS	MM_PROP_GAINCLASS_CLASS	An AUDIOGAINCLASS structure that describes the general parameters of a particular audio gain class.
  MM_PROPSET_GAINCLASS_STREAM	MM_PROP_GAINCLASS_STREAM	A STREAMPROPS structure that describes the parameters of a gain class for an audio stream.

• pvPropParams,
  An LPVOID pointer to any data type or structure that contains additional parameters that qualify the desired property. The data type that a property requires is defined by that property.

  The following table shows qualifiers that you must set for certain predefined property sets.

  Property	Required qualifier
  MM_PROP_GAINCLASS_CLASS	The ID of the gain class associated with the property set.

• cbPropParams,
  [in] A ULONG value that identifies the size, in bytes, of the data referenced by pvPropParams.

• pvPropData,
  [out] An LPVOID pointer to the data type that receives the requested property data. The data type that a property returns is defined by that property.

• cbPropData,
  [in] A ULONG value that identifies the size, in bytes, of the data referenced by pvPropData.

• pcbReturn
  [out] A PULONG pointer to a DWORD value that identifies the size of the data, in bytes, returned into pvPropData. This value should be less than or equal to the value that you originally provided in cbPropData.

Return Value

If successful, this function returns MMSYSERR_NOERROR.

If it fails, this function returns MMSYSERR_INVALPARAM, MMSYSERR_NODRIVER, or other driver-specific error messages.

To obtain extended error information, call the GetLastError function.

Requirements

See Also

Reference

Waveform Audio Functions
waveOutSetProperty
AUDIOGAINCLASS
STREAMPROPS

Concepts

Audio Gain Classes