waveOutPause function (mmeapi.h)

Article
02/22/2024

The waveOutPause function pauses playback on the given waveform-audio output device. The current position is saved. Use the waveOutRestart function to resume playback from the current position.

Syntax

MMRESULT waveOutPause(
  HWAVEOUT hwo
);

Parameters

hwo

Handle to the waveform-audio output device.

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.
MMSYSERR_NOTSUPPORTED	Specified device is synchronous and does not support pausing.

Remarks

Calling this function when the output is already paused has no effect, and the function returns zero.

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