next up previous contents index
Next: 5.1.2 write: Write to Up: 5.1 oskit_absio: Absolute I/O Previous: 5.1 oskit_absio: Absolute I/O

5.1.1 read: Read from this object, starting at specified offset

 

SYNOPSIS

#include <oskit/io/absio.h>

OSKIT_COMDECL oskit_absio_read(oskit_absio_t *f, void *buf, oskit_off_t offset, oskit_size_t amount, [out] oskit_size_t *out_actual);

DESCRIPTION

This method reads no more than amount bytes into buf from this object, starting at offset. out_actual is set to the actual number of bytes read.

PARAMETERS

f
The object from which to read.
buf
The buffer into which the data is to be copied.
offset
The offset in this object at which to start reading.
amount
The maximum number of bytes to read.
out_actual
The actual number of bytes read.

RETURNS

Returns 0 on success, or an error code specified in <oskit/error.h>, on error.



University of Utah Flux Research Group