Edit

midiStreamPosition function (mmeapi.h)

  • Article

The midiStreamPosition function retrieves the current position in a MIDI stream.

Syntax

MMRESULT midiStreamPosition(
  HMIDISTRM hms,
  LPMMTIME  lpmmt,
  UINT      cbmmt
);

Parameters

hms

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

lpmmt

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_INVALPARAM
 Specified pointer or structure is invalid.

Remarks

Before calling midiStreamPosition, set the wType member of the MMTIME structure to indicate the time format you desire. After calling midiStreamPosition, check the wType member to determine if the desired time format is supported. If the desired format is not supported, wType 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

See also

MIDI Functions