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

outputstream.h File Reference

Go to the source code of this file.

Typedefs

typedef xmlcpgOUTPUTSTREAM xmlcpgOutputStream
 The output stream type declaration.


Functions

void xmlcpgdeleteOutputStream (xmlcpgOutputStream *os)
 Destroys the output stream.

int xmlcpgisOutputStream (const xmlcpgOutputStream *os)
 Tells if the the object is an output stream.

int xmlcpggetOutputStreamEOS (const xmlcpgOutputStream *os)
 Tests the end of stream indicator of the output stream.

int xmlcpgflushOutputStream (xmlcpgOutputStream *os)
 Flushes the output stream.

int xmlcpgwriteOutputStreamChar (xmlcpgOutputStream *os, int c)
 Writes a character to the output stream.

int xmlcpgwriteOutputStream (xmlcpgOutputStream *os, const void *ptr, int nb)
 Writes some bytes of data from the buffer ptr.

int xmlcpgcloseOutputStream (xmlcpgOutputStream *os)
 Closes the output stream.

int xmlcpggetOutputStreamError (const xmlcpgOutputStream *os)
 Tests the error indicator of the output stream.

const char * xmlcpggetOutputStreamErrorString (const xmlcpgOutputStream *os)
 Gets the string describing the error.


Typedef Documentation

typedef struct xmlcpgOUTPUTSTREAM xmlcpgOutputStream
 

The output stream type declaration.


Function Documentation

int xmlcpgcloseOutputStream xmlcpgOutputStream   os
 

Closes the output stream.

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

void xmlcpgdeleteOutputStream xmlcpgOutputStream   os
 

Destroys the output stream.

The stream must be closed before with the xmlcpgcloseOutputStream function.

Parameters:
os  the output stream.

int xmlcpgflushOutputStream xmlcpgOutputStream   os
 

Flushes the output stream.

Parameters:
os  the output stream.
Returns:
0 on successful completion, -1 is returned otherwise.

int xmlcpggetOutputStreamEOS const xmlcpgOutputStream   os
 

Tests the end of stream indicator of the output stream.

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

int xmlcpggetOutputStreamError const xmlcpgOutputStream   os
 

Tests the error indicator of the output stream.

Parameters:
os  the output stream.
Returns:
a non-zero if an error occured.

const char* xmlcpggetOutputStreamErrorString const xmlcpgOutputStream   os
 

Gets the string describing the error.

Parameters:
os  the output stream.
Returns:
the error string.

int xmlcpgisOutputStream const xmlcpgOutputStream   os
 

Tells if the the object is an output stream.

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

int xmlcpgwriteOutputStream xmlcpgOutputStream   os,
const void *    ptr,
int    nb
 

Writes some bytes of data from the buffer ptr.

Parameters:
os  the output stream.
ptr  the bytes location.
nb  the number of bytes to write.
Returns:
the number of bytes written or 0 on end of stream or -1 on error.

int xmlcpgwriteOutputStreamChar xmlcpgOutputStream   os,
int    c
 

Writes a character to the output stream.

Parameters:
os  the output stream.
c  the character to write.
Returns:
the character written as an unsigned char cast to an int or -1 on error.


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