ReadFile v0.1.0

Source
Reads bytes from a file or I/O device.

Package: Windows

Microsoft documentation: ReadFile

Signature

func ReadFile(
    file: *opaque,
    buffer: *opaque,
    numberOfBytesToRead: uint32,
    numberOfBytesRead: *uint32,
    overlapped: *opaque
) -> bool32;

Parameters

NameDescription
fileOpen readable handle.
bufferWritable destination buffer.
numberOfBytesToReadMaximum requested byte count.
numberOfBytesReadReceives the actual count for synchronous I/O.
overlappedOverlapped state, or null for synchronous I/O.

Returns

bool32 — nonzero on completed success or zero on failure/pending overlapped I/O. A successful synchronous read can return fewer bytes than requested; zero bytes can indicate end of file.

See also