ToXMLStringTool Struct Reference

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

#include <xmlParser.h>

List of all members.

Public Member Functions
	ToXMLStringTool ()
	~ToXMLStringTool ()
void	freeBuffer ()
	call this function when you have finished using this object to release memory used by the internal buffer.
XMLSTR	toXML (XMLCSTR source)
	returns a pointer to an internal buffer that contains a XML-encoded string based on the "source" parameter.
Static Public Member Functions
static XMLSTR	toXMLUnSafe (XMLSTR dest, XMLCSTR source)
	The "toXMLUnSafe" function is deprecated because there is a possibility of "destination-buffer-overflow".
static int	lengthXMLString (XMLCSTR source)
	deprecated: use "toXML" instead

---

Detailed Description

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

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

&, ", ', <, > 

Using the "ToXMLStringTool 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 XMLNode class you must not use the "ToXMLStringTool" class (because the "XMLNode" class does the processing job for you during rendering).

Definition at line 657 of file xmlParser.h.

---

Constructor & Destructor Documentation

ToXMLStringTool::ToXMLStringTool

(

)

[inline]

Definition at line 660 of file xmlParser.h.

ToXMLStringTool::~ToXMLStringTool

(

)

Definition at line 738 of file xmlParser.cpp.

References freeBuffer().

---

Member Function Documentation

void ToXMLStringTool::freeBuffer

(

)

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

Definition at line 739 of file xmlParser.cpp.

Referenced by toXML(), and ~ToXMLStringTool().

int ToXMLStringTool::lengthXMLString

(

XMLCSTR

source

)

[static]

deprecated: use "toXML" instead

Definition at line 714 of file xmlParser.cpp.

References XMLCharacterEntity::c, XMLCharacterEntity::l, XMLCharacterEntity::s, XMLCHAR, and XMLEntities.

Referenced by toXML().

XMLSTR ToXMLStringTool::toXML

(

XMLCSTR

source

)

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

Definition at line 740 of file xmlParser.cpp.

References freeBuffer(), lengthXMLString(), toXMLUnSafe(), XMLCHAR, and XMLSTR.

XMLSTR ToXMLStringTool::toXMLUnSafe	(	XMLSTR	dest,
		XMLCSTR	source
	)		[static]

The "toXMLUnSafe" function is deprecated because there is a possibility of "destination-buffer-overflow".

It converts the string "source" to the string "dest". deprecated: use "toXML" instead

Definition at line 682 of file xmlParser.cpp.

References XMLCharacterEntity::c, XMLCharacterEntity::l, XMLCharacterEntity::s, XMLCHAR, XMLEntities, XMLSTR, and xstrcpy().

Referenced by toXML().

---

The documentation for this struct was generated from the following files:

• xmlParser.h
• xmlParser.cpp