mmioRead - Parameters

hmmio (HMMIO) - input

The open file handle returned by mmioOpen.

pchBuffer (PCHAR) - input

The buffer to read to.

cBytes (LONG) - input

The number of bytes to read from the file into the pchBuffer parameter.

rc (LONG) - returns

Returns the number of bytes actually read. If no more bytes can be read because the end of file has been reached, 0 is returned. If an error occurs, MMIO_ERROR is returned. A call to mmioGetLastError might return one of the following errors:

MMIOERR_WRITE_ONLY_FILE

File not opened in Read mode.
MMIOERR_READ_FAILED
Unable to read; probable hardware error.
MMIOERR_WRITE_FAILED
Writing to a full buffer before trying to read the next buffer failed.
MMIOERR_SEEK_FAILED
Unable to seek; probable hardware error.
MMIOERR_INVALID_BUFFER_LENGTH
The buffer length is invalid.
MMIOERR_NO_BUFFER_ALLOCATED
Write operation expected a buffer but none was allocated.

---

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