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

printstream.h File Reference

#include "outputstream.h"

Go to the source code of this file.

Typedefs

typedef xmlcpgPRINTSTREAM xmlcpgPrintStream
 The print stream type declaration.


Functions

xmlcpgPrintStreamxmlcpgnewPrintStream (xmlcpgOutputStream *os)
 Creates a new print stream with an output stream.

void xmlcpgdeletePrintStream (xmlcpgPrintStream *ps)
 Destroys the print stream.

int xmlcpgisPrintStream (const xmlcpgPrintStream *ps)
 Tells if the the object is a print stream.

void xmlcpgprintPrintStreamChar (xmlcpgPrintStream *ps, char c)
 Prints a character.

void xmlcpgprintPrintStreamString (xmlcpgPrintStream *ps, const char *s)
 Prints a string.

void xmlcpgprintPrintStreamFloat (xmlcpgPrintStream *ps, float f)
 Prints a float.

void xmlcpgprintPrintStreamDouble (xmlcpgPrintStream *ps, double d)
 Prints a double.

void xmlcpgprintPrintStreamInt (xmlcpgPrintStream *ps, int i)
 Prints an integer.

void xmlcpgprintPrintStreamUnsignedInt (xmlcpgPrintStream *ps, unsigned int u)
 Prints an unsigned integer.

void xmlcpgprintPrintStreamLong (xmlcpgPrintStream *ps, long l)
 Prints a long.

void xmlcpgprintPrintStreamLn (xmlcpgPrintStream *ps)
 Prints a newline.

int xmlcpggetPrintStreamEOS (const xmlcpgPrintStream *ps)
 Tests the end of stream indicator of the print stream.

int xmlcpgflushPrintStream (xmlcpgPrintStream *ps)
 Flushes the print stream.

int xmlcpgwritePrintStreamChar (xmlcpgPrintStream *ps, int c)
 Writes a character to the print stream.

int xmlcpgwritePrintStream (xmlcpgPrintStream *ps, const void *ptr, int nb)
 Writes some bytes of data to the location pointed by ptr.

int xmlcpgclosePrintStream (xmlcpgPrintStream *ps)
 Closes the print stream.

int xmlcpggetPrintStreamError (const xmlcpgPrintStream *ps)
 Tests the error indicator of the print stream.

const char * xmlcpggetPrintStreamErrorString (const xmlcpgPrintStream *ps)
 Gets the string describing the error.


Typedef Documentation

typedef struct xmlcpgPRINTSTREAM xmlcpgPrintStream
 

The print stream type declaration.


Function Documentation

int xmlcpgclosePrintStream xmlcpgPrintStream   ps
 

Closes the print stream.

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

void xmlcpgdeletePrintStream xmlcpgPrintStream   ps
 

Destroys the print stream.

The stream must be closed before with the xmlcpgclosePrintStream function.

Parameters:
ps  the print stream.

int xmlcpgflushPrintStream xmlcpgPrintStream   ps
 

Flushes the print stream.

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

int xmlcpggetPrintStreamEOS const xmlcpgPrintStream   ps
 

Tests the end of stream indicator of the print stream.

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

int xmlcpggetPrintStreamError const xmlcpgPrintStream   ps
 

Tests the error indicator of the print stream.

Parameters:
ps  the print stream.
Returns:
a non-zero if an error occured.

const char* xmlcpggetPrintStreamErrorString const xmlcpgPrintStream   ps
 

Gets the string describing the error.

Parameters:
ps  the print stream.
Returns:
the error string.

int xmlcpgisPrintStream const xmlcpgPrintStream   ps
 

Tells if the the object is a print stream.

Parameters:
ps  the print stream.
Returns:
0 if os is NULL or not a print stream, non-zero otherwise.

xmlcpgPrintStream* xmlcpgnewPrintStream xmlcpgOutputStream   os
 

Creates a new print stream with an output stream.

Parameters:
os  the output stream.
Returns:
the new print stream or NULL otherwise.

void xmlcpgprintPrintStreamChar xmlcpgPrintStream   ps,
char    c
 

Prints a character.

Parameters:
ps  the print stream.
c  the character.

void xmlcpgprintPrintStreamDouble xmlcpgPrintStream   ps,
double    d
 

Prints a double.

Parameters:
ps  the print stream.
d  the double.

void xmlcpgprintPrintStreamFloat xmlcpgPrintStream   ps,
float    f
 

Prints a float.

Parameters:
ps  the print stream.
f  the float.

void xmlcpgprintPrintStreamInt xmlcpgPrintStream   ps,
int    i
 

Prints an integer.

Parameters:
ps  the print stream.
i  the integer.

void xmlcpgprintPrintStreamLn xmlcpgPrintStream   ps
 

Prints a newline.

Parameters:
ps  the print stream.

void xmlcpgprintPrintStreamLong xmlcpgPrintStream   ps,
long    l
 

Prints a long.

Parameters:
ps  the print stream.
l  the long.

void xmlcpgprintPrintStreamString xmlcpgPrintStream   ps,
const char *    s
 

Prints a string.

Parameters:
ps  the print stream.
s  the string.

void xmlcpgprintPrintStreamUnsignedInt xmlcpgPrintStream   ps,
unsigned int    u
 

Prints an unsigned integer.

Parameters:
ps  the print stream.
u  the unsigned integer.

int xmlcpgwritePrintStream xmlcpgPrintStream   ps,
const void *    ptr,
int    nb
 

Writes some bytes of data to the location pointed by ptr.

Parameters:
ps  the print 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 xmlcpgwritePrintStreamChar xmlcpgPrintStream   ps,
int    c
 

Writes a character to the print stream.

Parameters:
ps  the print 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