midiStreamPause

The midiStreamPause function pauses playback of a specified MIDI stream.

MMRESULT midiStreamPause(
  HMIDISTRM hms  
);

Parameters

hms

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

Return Values

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

Value 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

  Windows NT/2000/XP: Included in Windows NT 3.1 and later.
  Windows 95/98/Me: Included in Windows 95 and later.
  Header: Declared in Mmsystem.h; include Windows.h.
  Library: Use Winmm.lib.

See Also

Musical Instrument Digital Interface (MIDI), MIDI Functions, MIDIEVENT, midiStreamRestart

Show: