waveInGetPosition function (mmeapi.h)

Article
02/22/2024

[waveInGetPosition is no longer supported for use as of Windows Vista. Instead, use IAudioClock::GetPosition.]

The waveInGetPosition function retrieves the current input position of the given waveform-audio input device.

Syntax

MMRESULT waveInGetPosition(
  HWAVEIN  hwi,
  LPMMTIME pmmt,
  UINT     cbmmt
);

Parameters

hwi

Handle to the waveform-audio input device.

pmmt

Pointer to an MMTIME structure.

cbmmt

Size, in bytes, of the MMTIME structure.

Return value

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

Return code	Description
MMSYSERR_INVALHANDLE	Specified device handle is invalid.
MMSYSERR_NODRIVER	No device driver is present.
MMSYSERR_NOMEM	Unable to allocate or lock memory.

Remarks

Before calling this function, set the wType member of the MMTIME structure to indicate the time format you want. After calling this function, check wType to determine whether the desired time format is supported. If the format is not supported, the member will specify an alternative format.

The position is set to zero when the device is opened or reset.

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