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

gzipinputstream.h File Reference

#include <zlib.h>
#include "fileinputstream.h"

Go to the source code of this file.

Typedefs

typedef xmlcpgGZIPINPUTSTREAM xmlcpgGZIPInputStream
 The gzip input stream declaration.


Functions

xmlcpgGZIPInputStreamxmlcpgnewGZIPInputStream (xmlcpgFileInputStream *is)
 Creates a new gzip input stream with a file input stream.

xmlcpgGZIPInputStreamxmlcpgnewGZIPInputStreamFD (int fd)
 Creates a new gzip input stream with a file descriptor.

void xmlcpgdeleteGZIPInputStream (xmlcpgGZIPInputStream *is)
 Destroys the gzip input stream.

int xmlcpgisGZIPInputStream (const xmlcpgGZIPInputStream *is)
 Tells if the the object is a gzip input stream.

int xmlcpggetGZIPInputStreamEOS (const xmlcpgGZIPInputStream *is)
 Tests the end of stream indicator of the gzip input stream.

int xmlcpgreadGZIPInputStreamChar (xmlcpgGZIPInputStream *is)
 Reads a character from the gzip input stream.

int xmlcpgreadGZIPInputStream (xmlcpgGZIPInputStream *is, void *ptr, int nbytes)
 Reads some bytes of data into the location pointed by ptr.

int xmlcpgcloseGZIPInputStream (xmlcpgGZIPInputStream *is)
 Closes the gzip input stream.

int xmlcpggetGZIPInputStreamError (const xmlcpgGZIPInputStream *is)
 Tests the error indicator of the gzip input stream.

const char * xmlcpggetGZIPInputStreamErrorString (const xmlcpgGZIPInputStream *is)
 Gets the string describing the error.


Typedef Documentation

typedef struct xmlcpgGZIPINPUTSTREAM xmlcpgGZIPInputStream
 

The gzip input stream declaration.


Function Documentation

int xmlcpgcloseGZIPInputStream xmlcpgGZIPInputStream   is
 

Closes the gzip input stream.

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

void xmlcpgdeleteGZIPInputStream xmlcpgGZIPInputStream   is
 

Destroys the gzip input stream.

The stream must be closed before with the xmlcpgcloseGZIPInputStream function.

Parameters:
is  the gzip input stream.

int xmlcpggetGZIPInputStreamEOS const xmlcpgGZIPInputStream   is
 

Tests the end of stream indicator of the gzip input stream.

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

int xmlcpggetGZIPInputStreamError const xmlcpgGZIPInputStream   is
 

Tests the error indicator of the gzip input stream.

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

const char* xmlcpggetGZIPInputStreamErrorString const xmlcpgGZIPInputStream   is
 

Gets the string describing the error.

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

int xmlcpgisGZIPInputStream const xmlcpgGZIPInputStream   is
 

Tells if the the object is a gzip input stream.

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

xmlcpgGZIPInputStream* xmlcpgnewGZIPInputStream xmlcpgFileInputStream   is
 

Creates a new gzip input stream with a file input stream.

The file input stream is freed on successful completion of the function.

Parameters:
is  the input file stream.
Returns:
the new gzip input stream or NULL otherwise.

xmlcpgGZIPInputStream* xmlcpgnewGZIPInputStreamFD int    fd
 

Creates a new gzip input stream with a file descriptor.

Parameters:
fd  the file descriptor.
Returns:
the new gzip input stream or NULL otherwise.

int xmlcpgreadGZIPInputStream xmlcpgGZIPInputStream   is,
void *    ptr,
int    nbytes
 

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

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

int xmlcpgreadGZIPInputStreamChar xmlcpgGZIPInputStream   is
 

Reads a character from the gzip input stream.

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


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