mmioAdvance - Parameters

hmmio (HMMIO) - input

The open file handle returned by mmioOpen.

pmmioinfo (PMMIOINFO) - input

A pointer to the MMIOINFO data structure that was filled in by mmioGetInfo.

usFlags (USHORT) - input

Specifies options for the operation. Contains one or more of the following flags:

MMIO_READ

The buffer is refilled from the file. MMIO_READ is used when the caller has finished reading data from the I/O buffer and wants the buffer to be refilled (if possible).
MMIO_WRITE
The buffer is written to the file and not refilled from the file. MMIO_WRITE is used when the caller has written to the end of the buffer and needs the buffer to be emptied (or expanded, in the case of a memory file).

rc (USHORT) - returns

Return codes indicating success or type of failure:

MMIO_SUCCESS

If the function succeeds, 0 is returned.
MMIOERR_UNBUFFERED
The specified file is not opened for buffered I/O.
MMIOERR_INVALID_HANDLE
The handle passed was not valid.
MMIOERR_INVALID_PARAMETER
An invalid parameter was passed.
MMIOERR_READ_ONLY_FILE
A write-advance operation was requested for a read-only file.
MMIOERR_WRITE_ONLY_FILE
A read-advance operation was requested for a file opened as write only.
MMIOERR_WRITE_FAILED
A write-advance operation failed.
MMIOERR_READ_FAILED
A read-advance operation failed.
MMIOERR_SEEK_FAILED
A seek operation prior to a write- or read-advance operation failed.
MMIOERR_NO_FLUSH_NEEDED
A write-advance operation was requested for the buffer, but the operation was not required.
MMIOERR_OUTOFMEMORY
An advance operation requires a buffer.
MMIOERR_CANNOTEXPAND
Unable to expand a MEM file for an advance request.
MMIOERR_FREE_FAILED
Unable to free a buffer after expanding a MEM file.

---

[Back: mmioAdvance Return Value - rc]
[Next: mmioAdvance - Remarks]