waveInGetProperty

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 input.

Syntax

MMRESULT waveInGetProperty (
  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.

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

• ulPropId
  [in] A ULONG value that is an index to identify a specific property within a property set. You can define your own values for properties within property sets.

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

• 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 or other driver-specific error messages.

Requirements

See Also

Reference

Waveform Audio Functions
waveInSetProperty
STREAMPROPS