sc68fordevelopers  2.2.1
Typedefs | Functions
istream68.h File Reference

generic stream operation. More...

Go to the source code of this file.

Typedefs

typedef struct _istream_t istream_t
 stream type. More...
 

Functions

const char * istream_filename (istream_t *istream)
 Get stream name. More...
 
int istream_open (istream_t *istream)
 Open stream. More...
 
int istream_close (istream_t *istream)
 Close stream. More...
 
int istream_read (istream_t *istream, void *data, int len)
 Read data from stream. More...
 
int istream_write (istream_t *istream, const void *data, int len)
 Write data into stream. More...
 
int istream_length (istream_t *istream)
 Get stream length. More...
 
int istream_tell (istream_t *istream)
 Get stream current position. More...
 
int istream_seek (istream_t *istream, int offset)
 Set stream relative position. More...
 
int istream_seek_to (istream_t *istream, int pos)
 Set stream absolute position. More...
 
void istream_destroy (istream_t *istream)
 Close and destroy stream. More...
 
int istream_gets (istream_t *istream, char *buffer, int max)
 Read a '\0' or '\n' terminated string. More...
 

Detailed Description

generic stream operation.

Author
benjamin gerard
Date
2003/08/08
Id
istream68.h,v 2.3 2003/09/06 16:13:12 benjihan Exp

isteam68 provides functions for stream operations.

Typedef Documentation

typedef struct _istream_t istream_t

stream type.

Function Documentation

const char* istream_filename ( istream_t istream)

Get stream name.

Parameters
istreamstream
Returns
stream name
Return values
0Failure.
int istream_open ( istream_t istream)

Open stream.

Parameters
istreamstream
Returns
error code
Return values
0Success
-1Failure
int istream_close ( istream_t istream)

Close stream.

Parameters
istreamstream
Returns
error code
Return values
0Success
-1Failure
int istream_read ( istream_t istream,
void *  data,
int  len 
)

Read data from stream.

Parameters
istreamstream
datadestination buffer
lennumber of byte to read
Returns
number of byte read
Return values
-1Failure.
int istream_write ( istream_t istream,
const void *  data,
int  len 
)

Write data into stream.

Parameters
istreamstream
datadestination buffer
lennumber of byte to read
Returns
number of byte written
Return values
-1Failure.
int istream_length ( istream_t istream)

Get stream length.

Parameters
istreamstream
Returns
number of bytes.
Return values
-1Failure.
int istream_tell ( istream_t istream)

Get stream current position.

Parameters
istreamstream
Returns
stream position
Return values
-1Failure.
int istream_seek ( istream_t istream,
int  offset 
)

Set stream relative position.

Parameters
istreamstream
offsetdisplacement from current position
Returns
Absolute position after seeking
Return values
-1Failure.
See also
istream_seek_to()
int istream_seek_to ( istream_t istream,
int  pos 
)

Set stream absolute position.

Parameters
istreamstream
posposition to reach
Returns
Absolute position after seeking
Return values
-1Failure.
See also
istream_seek()
void istream_destroy ( istream_t istream)

Close and destroy stream.

Parameters
istreamstream
int istream_gets ( istream_t istream,
char *  buffer,
int  max 
)

Read a '\0' or '\n' terminated string.

Parameters
istreamstream
bufferdestination buffer
maxdestination buffer size
Returns
number of char read
Return values
-1Failure.