midiStreamPause

The midiStreamPause function pauses playback of a specified MIDI stream. 

MMRESULT midiStreamPause(
  HMIDISTRM hms  
);

Parameters

hms
Handle of 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.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in mmsystem.h.
  Import Library: Use winmm.lib.

See Also

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