next up previous contents index
Next: 4.8.2 write: Write to Up: 4.8 oskit_stream: standard interface Previous: 4.8 oskit_stream: standard interface

4.8.1 read: Read from this stream, starting at the seek pointer

 

SYNOPSIS

#include <oskit/com/stream.h>

OSKIT_COMDECL oskit_stream_read(oskit_stream_t *f, void *buf, oskit_u32_t len, [out] oskit_u32_t *out_actual);

DESCRIPTION

This method reads no more than len bytes into buf from this stream, starting at the current seek pointer of this stream. 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.
len
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