IncredibleXMLParser  3.05
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members

Helper class to create XML files using "printf", "fprintf", "cout",... functions. More...

#include <IXMLParser.h>

Public Types

enum  IXMLStringLocation { IXMLStringLocation_unknown =0, IXMLStringLocation_inAttribute =1, IXMLStringLocation_inText =2 }
 Enumeration for XML String location. More...
 
typedef enum
ToIXMLStringTool::IXMLStringLocation 
IXMLStringLocation
 Enumeration for XML String location. More...
 

Public Member Functions

 ToIXMLStringTool (IXMLStringLocation loc=IXMLStringLocation_unknown)
 
 ~ToIXMLStringTool ()
 
void clear ()
 call this function when you have finished using this object to release memory used by the internal buffer. More...
 
void setLocation (IXMLStringLocation loc=IXMLStringLocation_unknown)
 
IXMLStringLocation getLocation ()
 
IXMLStr toXML (IXMLCStr source)
 returns a pointer to an internal buffer that contains a XML-encoded string based on the "source" parameter. More...
 
IXMLStr toXMLUnSafe (IXMLStr dest, IXMLCStr source)
 deprecated: use "toXML" instead More...
 
int lengthXMLString (IXMLCStr source)
 deprecated: use "toXML" instead More...
 
char setCharEncoding (IXMLPullParser::IXMLCharEncoding encoding=IXMLPullParser::char_encoding_UTF8)
 
IXMLPullParser::IXMLCharEncoding getCharEncoding ()
 

Detailed Description

Helper class to create XML files using "printf", "fprintf", "cout",... functions.

The ToIXMLStringTool class helps you creating XML files using "printf", "fprintf", "cout",... functions. The "ToIXMLStringTool" class is processing strings so that all the characters &,",',<,> are replaced by their XML equivalent:

&amp;, &quot;, &apos;, &lt;, &gt; 

Using the "ToIXMLStringTool class" and the "fprintf function" is THE most efficient way to produce VERY large XML documents VERY fast.

Note
If you are creating from scratch an XML file using the provided IXMLNode class you must not use the "ToIXMLStringTool" class (because the "IXMLNode" class does the processing job for you during rendering).

Definition at line 1287 of file IXMLParser.h.

Member Typedef Documentation

Enumeration for XML String location.

Member Enumeration Documentation

Enumeration for XML String location.

Enumerator
IXMLStringLocation_unknown 
IXMLStringLocation_inAttribute 
IXMLStringLocation_inText 

Definition at line 1291 of file IXMLParser.h.

Constructor & Destructor Documentation

ToIXMLStringTool::ToIXMLStringTool ( IXMLStringLocation  loc = IXMLStringLocation_unknown)
ToIXMLStringTool::~ToIXMLStringTool ( )

Member Function Documentation

void ToIXMLStringTool::clear ( )

call this function when you have finished using this object to release memory used by the internal buffer.

IXMLPullParser::IXMLCharEncoding ToIXMLStringTool::getCharEncoding ( )
IXMLStringLocation ToIXMLStringTool::getLocation ( )
int ToIXMLStringTool::lengthXMLString ( IXMLCStr  source)

deprecated: use "toXML" instead

char ToIXMLStringTool::setCharEncoding ( IXMLPullParser::IXMLCharEncoding  encoding = IXMLPullParser::char_encoding_UTF8)
void ToIXMLStringTool::setLocation ( IXMLStringLocation  loc = IXMLStringLocation_unknown)
IXMLStr ToIXMLStringTool::toXML ( IXMLCStr  source)

returns a pointer to an internal buffer that contains a XML-encoded string based on the "source" parameter.

Referenced by example11().

IXMLStr ToIXMLStringTool::toXMLUnSafe ( IXMLStr  dest,
IXMLCStr  source 
)

deprecated: use "toXML" instead

The "toXMLUnSafe" function is deprecated because there is a possibility of "destination-buffer-overflow". It converts the string "source" to the string "dest".


The documentation for this class was generated from the following file: