Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

inputstream.c File Reference

#include <errno.h>
#include <string.h>
#include "fileinputstream.h"
#include "gzipinputstream.h"
#include "inputstream.h"
#include "xmlcpg.h"

Compounds

struct  xmlcpgINPUTSTREAM

Functions

void xmlcpgdeleteInputStream (xmlcpgInputStream *is)
 Destroys the input stream.

int xmlcpgisInputStream (const xmlcpgInputStream *is)
 Tells if the the object is an input stream.

int xmlcpggetInputStreamEOS (const xmlcpgInputStream *is)
 Tests the end of stream indicator of the input stream.

int xmlcpgreadInputStreamChar (xmlcpgInputStream *is)
 Reads a character from the input stream.

int xmlcpgreadInputStream (xmlcpgInputStream *is, void *ptr, int size)
 Reads some bytes of data into the location pointed by ptr.

int xmlcpgcloseInputStream (xmlcpgInputStream *is)
 Closes the input stream.

int xmlcpggetInputStreamError (const xmlcpgInputStream *is)
 Tests the error indicator of the input stream.

const char * xmlcpggetInputStreamErrorString (const xmlcpgInputStream *is)
 Gets the string describing the error.


Function Documentation

int xmlcpgcloseInputStream xmlcpgInputStream   is
 

Closes the input stream.

Parameters:
is  the input stream.
Returns:
0 upon successful completion, -1 is returned otherwise.

void xmlcpgdeleteInputStream xmlcpgInputStream   is
 

Destroys the input stream.

The stream must be closed before with the xmlcpgcloseInputStream function.

Parameters:
is  the input stream.

int xmlcpggetInputStreamEOS const xmlcpgInputStream   is
 

Tests the end of stream indicator of the input stream.

Parameters:
is  the input stream.
Returns:
a non-zero if it is set or if is is not an input stream.

int xmlcpggetInputStreamError const xmlcpgInputStream   is
 

Tests the error indicator of the input stream.

Parameters:
is  the input stream.
Returns:
a non-zero if an error occured.

const char* xmlcpggetInputStreamErrorString const xmlcpgInputStream   is
 

Gets the string describing the error.

Parameters:
is  the input stream.
Returns:
the error string.

int xmlcpgisInputStream const xmlcpgInputStream   is
 

Tells if the the object is an input stream.

Parameters:
is  the input stream.
Returns:
0 if is is NULL or not an input stream, non-zero otherwise.

int xmlcpgreadInputStream xmlcpgInputStream   is,
void *    ptr,
int    size
 

Reads some bytes of data into the location pointed by ptr.

Parameters:
is  the input stream.
ptr  the location where to store the input.
size  the number of bytes to read.
Returns:
the number of bytes read or 0 on end of stream or -1 on error.

int xmlcpgreadInputStreamChar xmlcpgInputStream   is
 

Reads a character from the input stream.

Parameters:
is  the input stream.
Returns:
the character cast to an int or -1 on end of stream or error.


Generated on Tue Nov 11 14:59:48 2003 for xmlcpg by doxygen1.2.18