midiOutPrepareHeader function
The midiOutPrepareHeader function prepares a MIDI system-exclusive or stream buffer for output.
Syntax
MMRESULT midiOutPrepareHeader(
HMIDIOUT hmo,
LPMIDIHDR lpMidiOutHdr,
UINT cbMidiOutHdr
);
Parameters
hmo
Handle to the MIDI output device. To get the device handle, call midiOutOpen. This parameter can also be the handle of a MIDI stream cast to a HMIDIOUT type.lpMidiOutHdr
Pointer to a MIDIHDR structure that identifies the buffer to be prepared.Before calling the function, set the lpData, dwBufferLength, and dwFlags members of the MIDIHDR structure. The dwFlags member must be set to zero.
cbMidiOutHdr
Size, in bytes, of the MIDIHDR structure.
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. |
| MMSYSERR_INVALPARAM | The specified address is invalid or the given stream buffer is greater than 64K. |
| MMSYSERR_NOMEM | The system is unable to allocate or lock memory. |
Remarks
Before you pass a MIDI data block to a device driver, you must prepare the buffer by passing it to the midiOutPrepareHeader function. After the header has been prepared, do not modify the buffer. After the driver is done using the buffer, call the midiOutUnprepareHeader function.
The application can re-use the same buffer, or allocate multiple buffers and call midiOutPrepareHeader for each buffer. If you re-use the same buffer, it is not necessary to prepare the buffer each time. You can call midiOutPrepareHeader once at the beginning and then call midiOutUnprepareHeader once at the end.
A stream buffer cannot be larger than 64K.
Preparing a header that has already been prepared 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] |
Header |
Mmsystem.h (include Windows.h) |
Library |
Winmm.lib |
DLL |
Winmm.dll |