midiStreamPause function

The midiStreamPause function pauses playback of a specified MIDI stream.

Syntax

MMRESULT midiStreamPause(
  HMIDISTRM hms
);

Parameters

hms

Handle to a MIDI stream. This handle must have been returned by a call to the MIDIEVENT function. This handle identifies the output device.

Return Value

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

Return code Description
MMSYSERR_INVALHANDLE
The specified device handle is invalid.

Remarks

The current playback position is saved when playback is paused. To resume playback from the current position, use the midiStreamRestart function.

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

Requirements

   
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

See Also

MIDI Functions