Pointer to a header structure. This structure contains
the data that is written to the header.
If the MMIO_TRANSLATEHEADER flag was set on the mmioOpen
in the ulTranslate field of the MMIOINFO
structure on the mmioOpen function,
then the header expected by the call is one associated with the standard
presentation format for that particular multimedia data type (media type).
Each media type (see the ulMediaType field of the MMFORMATINFO
structure.) has a different standard presentation header.
The I/O procedure is expected to transpose the header from this standard
format into the native format before writing the header to the file.
If MMIO_NOTRANSLATE was specified on the open (default case) then the header
is in its native format. The currently defined values for each ulMediaType
and their respective media structures are as follows:
MMIO_MEDIATYPE_IMAGE
The data represents a still
image. Images use the MMIMAGEHEADER
as the media structure.
MMIO_MEDIATYPE_AUDIO
The data represents digital audio. Digital-audio
data streams use MMAUDIOHEADER as
the media structure.
MMIO_MEDIATYPE_MIDI
The
data represents MIDI streams. MIDI data streams use MMMIDIHEADER
as the media structure.
MMIO_MEDIATYPE_DIGITALVIDEO
The data represents digital video. Digital video
data uses MMVIDEOHEADER as the
media structure.
MMIO_MEDIATYPE_MOVIE
lHeaderLength (LONG) -
input
The size of the header structure in bytes.
plBytesWritten (PLONG)
- in/out
Returns the number of bytes written to
the header structure.
ulReserved (ULONG) - input
Reserved for future use and must be set to zero.
ulFlags (ULONG) - input
Reserved for future use and must be set to zero.
rc (ULONG) - returns
Return
codes indicating success or type of failure:
MMIO_SUCCESS
If the function succeeds, 0 is returned.
MMIO_ERROR
The specified
file is not a media-file format type.
MMIOERR_INVALID_PARAMETER
An invalid parameter was passed.
MMIOERR_INVALID_HANDLE
The handle passed was not valid.
MMIOERR_SEEK_FAILED
A seek operation prior to a write- or read-advance
operation failed.
[Back: mmioSetHeader Return Value - rc]
[Next: mmioSetHeader - Remarks]