Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

istream68.h File Reference


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.

Go to the source code of this file.

Typedefs

typedef _istream_t istream_t
 stream type.

Functions

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


Function Documentation

const char* istream_filename istream_t istream  ) 
 

Get stream name.

Parameters:
istream stream
Returns:
stream name
Return values:
0 Failure.

int istream_open istream_t istream  ) 
 

Open stream.

Parameters:
istream stream
Returns:
error code
Return values:
0 Success
-1 Failure

int istream_close istream_t istream  ) 
 

Close stream.

Parameters:
istream stream
Returns:
error code
Return values:
0 Success
-1 Failure

int istream_read istream_t istream,
void *  data,
int  len
 

Read data from stream.

Parameters:
istream stream
data destination buffer
len number of byte to read
Returns:
number of byte read
Return values:
-1 Failure.

int istream_write istream_t istream,
const void *  data,
int  len
 

Write data into stream.

Parameters:
istream stream
data destination buffer
len number of byte to read
Returns:
number of byte written
Return values:
-1 Failure.

int istream_length istream_t istream  ) 
 

Get stream length.

Parameters:
istream stream
Returns:
number of bytes.
Return values:
-1 Failure.

int istream_tell istream_t istream  ) 
 

Get stream current position.

Parameters:
istream stream
Returns:
stream position
Return values:
-1 Failure.

int istream_seek istream_t istream,
int  offset
 

Set stream relative position.

Parameters:
istream stream
offset displacement from current position
Returns:
Absolute position after seeking
Return values:
-1 Failure.
See also:
istream_seek_to()

int istream_seek_to istream_t istream,
int  pos
 

Set stream absolute position.

Parameters:
istream stream
pos position to reach
Returns:
Absolute position after seeking
Return values:
-1 Failure.
See also:
istream_seek()

void istream_destroy istream_t istream  ) 
 

Close and destroy stream.

Parameters:
istream stream

int istream_gets istream_t istream,
char *  buffer,
int  max
 

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

Parameters:
istream stream
buffer destination buffer
max destination buffer size
Returns:
number of char read
Return values:
-1 Failure.


Generated on Fri Jan 21 13:18:17 2005 for sc68fordevelopers by  doxygen 1.3.9.1