<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: TiXmlDocument Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1TiXmlDocument.html">TiXmlDocument</a>
</div>
</div>
<div class="contents">
<h1>TiXmlDocument Class Reference</h1><!-- doxytag: class="TelEngine::TiXmlDocument" --><!-- doxytag: inherits="TelEngine::TiXmlNode" --><code>#include <<a class="el" href="tinyxml_8h-source.html">tinyxml.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for TiXmlDocument:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1TiXmlDocument.png" usemap="#TiXmlDocument_map" border="0" alt=""></center>
<map name="TiXmlDocument_map">
<area href="classTelEngine_1_1TiXmlNode.html" alt="TiXmlNode" shape="rect" coords="0,56,99,80">
<area href="classTelEngine_1_1TiXmlBase.html" alt="TiXmlBase" shape="rect" coords="0,0,99,24">
<area href="classTelEngine_1_1XMLParser.html" alt="XMLParser" shape="rect" coords="0,168,99,192">
</map>
</div>
<p>
<a href="classTelEngine_1_1TiXmlDocument-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7660c6ed16ceff9894b8edbe8aed44ca"></a><!-- doxytag: member="TelEngine::TiXmlDocument::TiXmlDocument" ref="7660c6ed16ceff9894b8edbe8aed44ca" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#7660c6ed16ceff9894b8edbe8aed44ca">TiXmlDocument</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an empty document, that has no name. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e6b2ef8b2a91b896833fac7d9201a45d"></a><!-- doxytag: member="TelEngine::TiXmlDocument::TiXmlDocument" ref="e6b2ef8b2a91b896833fac7d9201a45d" args="(const char *documentName)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#e6b2ef8b2a91b896833fac7d9201a45d">TiXmlDocument</a> (const char *documentName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a document with a name. The name of the document is also the filename of the xml. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="fbc46d5103ad394808e024497cc9d120"></a><!-- doxytag: member="TelEngine::TiXmlDocument::TiXmlDocument" ref="fbc46d5103ad394808e024497cc9d120" args="(const std::string &documentName)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#fbc46d5103ad394808e024497cc9d120">TiXmlDocument</a> (const std::string &documentName)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8a88acf738ffa1888de8d07a0d6f7cfb"></a><!-- doxytag: member="TelEngine::TiXmlDocument::TiXmlDocument" ref="8a88acf738ffa1888de8d07a0d6f7cfb" args="(const TiXmlDocument &copy)" -->
</td><td class="memItemRight" valign="bottom"><b>TiXmlDocument</b> (const <a class="el" href="classTelEngine_1_1TiXmlDocument.html">TiXmlDocument</a> &copy)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9795f287dd952bba899652b019ff85ff"></a><!-- doxytag: member="TelEngine::TiXmlDocument::operator=" ref="9795f287dd952bba899652b019ff85ff" args="(const TiXmlDocument &copy)" -->
void </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classTelEngine_1_1TiXmlDocument.html">TiXmlDocument</a> &copy)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#3853e4fa22d120447e98bcab934b2070">LoadFile</a> (TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b0f006d2b187ec5c6f8098e8b1848e7b"></a><!-- doxytag: member="TelEngine::TiXmlDocument::SaveFile" ref="b0f006d2b187ec5c6f8098e8b1848e7b" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#b0f006d2b187ec5c6f8098e8b1848e7b">SaveFile</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a file using the current document value. Returns true if successful. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f72de2336c37b33c9a4ec440caf60068"></a><!-- doxytag: member="TelEngine::TiXmlDocument::LoadFile" ref="f72de2336c37b33c9a4ec440caf60068" args="(const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#f72de2336c37b33c9a4ec440caf60068">LoadFile</a> (const char *filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a file using the given filename. Returns true if successful. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c1bf76b47880d666aa235ae64e273736"></a><!-- doxytag: member="TelEngine::TiXmlDocument::SaveFile" ref="c1bf76b47880d666aa235ae64e273736" args="(const char *filename) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#c1bf76b47880d666aa235ae64e273736">SaveFile</a> (const char *filename) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a file using the given filename. Returns true if successful. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#7925519dc5b7f52b35f3f3075bc0041b">LoadFile</a> (FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ce8d0e69881ba9a0dfda49fa12aed6a9"></a><!-- doxytag: member="TelEngine::TiXmlDocument::SaveFile" ref="ce8d0e69881ba9a0dfda49fa12aed6a9" args="(FILE *) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#ce8d0e69881ba9a0dfda49fa12aed6a9">SaveFile</a> (FILE *) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Save a file using the given FILE*. Returns true if successful. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#146453f24657d573e1154b5f5ce1fea5">LoadFile</a> (const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d31a4da19ddb53b4e1a1d6602950d5dd"></a><!-- doxytag: member="TelEngine::TiXmlDocument::SaveFile" ref="d31a4da19ddb53b4e1a1d6602950d5dd" args="(const std::string &filename) const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#d31a4da19ddb53b4e1a1d6602950d5dd">SaveFile</a> (const std::string &filename) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">< STL std::string version. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#7f2b27105537a0ec4bfb961c40bb0d64">Parse</a> (const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classTelEngine_1_1TiXmlElement.html">TiXmlElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#cdbf63eb9f24db17a52066d28cc52409">RootElement</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="516d5e53686d62142d716757bfbf80e7"></a><!-- doxytag: member="TelEngine::TiXmlDocument::RootElement" ref="516d5e53686d62142d716757bfbf80e7" args="()" -->
<a class="el" href="classTelEngine_1_1TiXmlElement.html">TiXmlElement</a> * </td><td class="memItemRight" valign="bottom"><b>RootElement</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#7f351111b1715879a6029d189f7457e1">Error</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d1e7abe3926fb683abae7b170d73cc4"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ErrorDesc" ref="7d1e7abe3926fb683abae7b170d73cc4" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#7d1e7abe3926fb683abae7b170d73cc4">ErrorDesc</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contains a textual (english) description of the error if one occurs. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#85f5573d8b045fd19ebf476dffb309be">ErrorId</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#b3cea712762b242cd4af6f2d98ab0236">ErrorRow</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="270f533f0de05ad770edc70afa660989"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ErrorCol" ref="270f533f0de05ad770edc70afa660989" args="()" -->
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#270f533f0de05ad770edc70afa660989">ErrorCol</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The column where the error occured. See <a class="el" href="classTelEngine_1_1TiXmlDocument.html#b3cea712762b242cd4af6f2d98ab0236">ErrorRow()</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#e52c1e6d112677e7fce608a2de6201bd">SetTabSize</a> (int _tabsize)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8fd333902306c5124ecf2e138d9b03b"></a><!-- doxytag: member="TelEngine::TiXmlDocument::TabSize" ref="b8fd333902306c5124ecf2e138d9b03b" args="() const " -->
int </td><td class="memItemRight" valign="bottom"><b>TabSize</b> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#93f7a306ed9bf1f41de89f2afea7f55d">ClearError</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#11421e368566880f5aaa4f39ce8885c4">Print</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d9fe3cf302a6e37b9a49c37a3cfdf08"></a><!-- doxytag: member="TelEngine::TiXmlDocument::Print" ref="7d9fe3cf302a6e37b9a49c37a3cfdf08" args="(FILE *cfile, int depth=0) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#7d9fe3cf302a6e37b9a49c37a3cfdf08">Print</a> (FILE *cfile, int depth=0) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print this Document to a FILE stream. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="212e380d42b426f92b7b375260a17d16"></a><!-- doxytag: member="TelEngine::TiXmlDocument::SetError" ref="212e380d42b426f92b7b375260a17d16" args="(int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)" -->
void </td><td class="memItemRight" valign="bottom"><b>SetError</b> (int err, const char *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0ac5163cd2f090c512d09453d445988a"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ToDocument" ref="0ac5163cd2f090c512d09453d445988a" args="() const " -->
virtual const <a class="el" href="classTelEngine_1_1TiXmlDocument.html">TiXmlDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#0ac5163cd2f090c512d09453d445988a">ToDocument</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast to a more defined type. Will return null not of the requested type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="46a5535cabc469a65f47acc317fea778"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ToDocument" ref="46a5535cabc469a65f47acc317fea778" args="()" -->
virtual <a class="el" href="classTelEngine_1_1TiXmlDocument.html">TiXmlDocument</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#46a5535cabc469a65f47acc317fea778">ToDocument</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Cast to a more defined type. Will return null not of the requested type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38848efd07a0e5dc4994b8b266740953"></a><!-- doxytag: member="TelEngine::TiXmlDocument::StreamOut" ref="38848efd07a0e5dc4994b8b266740953" args="(TIXML_OSTREAM *out, bool unclosed=false) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><b>StreamOut</b> (TIXML_OSTREAM *out, bool unclosed=false) const </td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classTelEngine_1_1TiXmlNode.html">TiXmlNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1TiXmlDocument.html#842a98f3a31af4a808cee9d8842e5072">Clone</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="8693fd4b2b20c70468dd84074e98b678"></a><!-- doxytag: member="TelEngine::TiXmlDocument::StreamIn" ref="8693fd4b2b20c70468dd84074e98b678" args="(TIXML_ISTREAM *in, TIXML_STRING *tag)" -->
virtual void </td><td class="memItemRight" valign="bottom"><b>StreamIn</b> (TIXML_ISTREAM *in, TIXML_STRING *tag)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Always the top level node. A document binds together all the XML pieces. It can be saved, loaded, and printed to the screen. The 'value' of a document node is the xml file name. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="93f7a306ed9bf1f41de89f2afea7f55d"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ClearError" ref="93f7a306ed9bf1f41de89f2afea7f55d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ClearError </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If you have handled the error, it can be reset with this call. The error state is automatically cleared if you Parse a new XML block.
</div>
</div><p>
<a class="anchor" name="842a98f3a31af4a808cee9d8842e5072"></a><!-- doxytag: member="TelEngine::TiXmlDocument::Clone" ref="842a98f3a31af4a808cee9d8842e5072" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classTelEngine_1_1TiXmlNode.html">TiXmlNode</a>* Clone </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an exact duplicate of this node and return it. The memory must be deleted by the caller.
<p>Implements <a class="el" href="classTelEngine_1_1TiXmlNode.html#5455583176e9a0389caa2f94ffb809fc">TiXmlNode</a>.</p>
</div>
</div><p>
<a class="anchor" name="7f351111b1715879a6029d189f7457e1"></a><!-- doxytag: member="TelEngine::TiXmlDocument::Error" ref="7f351111b1715879a6029d189f7457e1" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Error </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
If an error occurs, Error will be set to true. Also,<ul>
<li>The <a class="el" href="classTelEngine_1_1TiXmlDocument.html#85f5573d8b045fd19ebf476dffb309be">ErrorId()</a> will contain the integer identifier of the error (not generally useful)</li><li>The <a class="el" href="classTelEngine_1_1TiXmlDocument.html#7d1e7abe3926fb683abae7b170d73cc4" title="Contains a textual (english) description of the error if one occurs.">ErrorDesc()</a> method will return the name of the error. (very useful)</li><li>The <a class="el" href="classTelEngine_1_1TiXmlDocument.html#b3cea712762b242cd4af6f2d98ab0236">ErrorRow()</a> and <a class="el" href="classTelEngine_1_1TiXmlDocument.html#270f533f0de05ad770edc70afa660989" title="The column where the error occured. See ErrorRow().">ErrorCol()</a> will return the location of the error (if known) </li></ul>
</div>
</div><p>
<a class="anchor" name="85f5573d8b045fd19ebf476dffb309be"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ErrorId" ref="85f5573d8b045fd19ebf476dffb309be" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ErrorId </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generally, you probably want the error string ( <a class="el" href="classTelEngine_1_1TiXmlDocument.html#7d1e7abe3926fb683abae7b170d73cc4" title="Contains a textual (english) description of the error if one occurs.">ErrorDesc()</a> ). But if you prefer the ErrorId, this function will fetch it.
</div>
</div><p>
<a class="anchor" name="b3cea712762b242cd4af6f2d98ab0236"></a><!-- doxytag: member="TelEngine::TiXmlDocument::ErrorRow" ref="b3cea712762b242cd4af6f2d98ab0236" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ErrorRow </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the location (if known) of the error. The first column is column 1, and the first row is row 1. A value of 0 means the row and column wasn't applicable (memory errors, for example, have no row/column) or the parser lost the error. (An error in the error reporting, in that case.)<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classTelEngine_1_1TiXmlDocument.html#e52c1e6d112677e7fce608a2de6201bd">SetTabSize</a>, <a class="el" href="classTelEngine_1_1TiXmlBase.html#8b8f21430c62433a48c592277a3bd7a2">Row</a>, <a class="el" href="classTelEngine_1_1TiXmlBase.html#b01a75ed9853cd6e22f06a61d173f229" title="See Row().">Column</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="146453f24657d573e1154b5f5ce1fea5"></a><!-- doxytag: member="TelEngine::TiXmlDocument::LoadFile" ref="146453f24657d573e1154b5f5ce1fea5" args="(const std::string &filename, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool LoadFile </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"> <em>encoding</em> = <code>TIXML_DEFAULT_ENCODING</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Parameters: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em>encoding</em> </td><td>
STL std::string version. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="7925519dc5b7f52b35f3f3075bc0041b"></a><!-- doxytag: member="TelEngine::TiXmlDocument::LoadFile" ref="7925519dc5b7f52b35f3f3075bc0041b" args="(FILE *, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool LoadFile </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"> <em>encoding</em> = <code>TIXML_DEFAULT_ENCODING</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a file using the given FILE*. Returns true if successful. Note that this method doesn't stream - the entire object pointed at by the FILE* will be interpreted as an XML file. TinyXML doesn't stream in XML from the current file location. Streaming may be added in the future.
</div>
</div><p>
<a class="anchor" name="3853e4fa22d120447e98bcab934b2070"></a><!-- doxytag: member="TelEngine::TiXmlDocument::LoadFile" ref="3853e4fa22d120447e98bcab934b2070" args="(TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool LoadFile </td>
<td>(</td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"> <em>encoding</em> = <code>TIXML_DEFAULT_ENCODING</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.
</div>
</div><p>
<a class="anchor" name="7f2b27105537a0ec4bfb961c40bb0d64"></a><!-- doxytag: member="TelEngine::TiXmlDocument::Parse" ref="7f2b27105537a0ec4bfb961c40bb0d64" args="(const char *p, TiXmlParsingData *data=0, TiXmlEncoding encoding=TIXML_DEFAULT_ENCODING)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Parse </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>p</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlParsingData * </td>
<td class="paramname"> <em>data</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TiXmlEncoding </td>
<td class="paramname"> <em>encoding</em> = <code>TIXML_DEFAULT_ENCODING</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse the given null terminated block of xml data. Passing in an encoding to this method (either TIXML_ENCODING_LEGACY or TIXML_ENCODING_UTF8 will force TinyXml to use that encoding, regardless of what TinyXml might otherwise try to detect. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The location where parsing stopped. On error, this is the start point of the first level node that generated the error. </dd></dl>
<p>Implements <a class="el" href="classTelEngine_1_1TiXmlBase.html">TiXmlBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="11421e368566880f5aaa4f39ce8885c4"></a><!-- doxytag: member="TelEngine::TiXmlDocument::Print" ref="11421e368566880f5aaa4f39ce8885c4" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Print </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Dump the document to standard out.
<p>References <a class="el" href="tinyxml_8h-source.html#l01397">TiXmlDocument::Print()</a>.</p>
<p>Referenced by <a class="el" href="tinyxml_8h-source.html#l01397">TiXmlDocument::Print()</a>.</p>
</div>
</div><p>
<a class="anchor" name="cdbf63eb9f24db17a52066d28cc52409"></a><!-- doxytag: member="TelEngine::TiXmlDocument::RootElement" ref="cdbf63eb9f24db17a52066d28cc52409" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classTelEngine_1_1TiXmlElement.html">TiXmlElement</a>* RootElement </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the root element -- the only top level element -- of the document. In well formed XML, there should only be one. TinyXml is tolerant of multiple elements at the document level.
</div>
</div><p>
<a class="anchor" name="e52c1e6d112677e7fce608a2de6201bd"></a><!-- doxytag: member="TelEngine::TiXmlDocument::SetTabSize" ref="e52c1e6d112677e7fce608a2de6201bd" args="(int _tabsize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SetTabSize </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>_tabsize</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<a class="el" href="classTelEngine_1_1TiXmlDocument.html#e52c1e6d112677e7fce608a2de6201bd">SetTabSize()</a> allows the error reporting functions (<a class="el" href="classTelEngine_1_1TiXmlDocument.html#b3cea712762b242cd4af6f2d98ab0236">ErrorRow()</a> and <a class="el" href="classTelEngine_1_1TiXmlDocument.html#270f533f0de05ad770edc70afa660989" title="The column where the error occured. See ErrorRow().">ErrorCol()</a>) to report the correct values for row and column. It does not change the output or input in any way.<p>
By calling this method, with a tab size greater than 0, the row and column of each node and attribute is stored when the file is loaded. Very useful for tracking the DOM back in to the source file.<p>
The tab size is required for calculating the location of nodes. If not set, the default of 4 is used. The tabsize is set per document. Setting the tabsize to 0 disables row/column tracking.<p>
Note that row and column tracking is not supported when using operator>>.<p>
The tab size needs to be enabled before the parse or load. Correct usage: <div class="fragment"><pre class="fragment">
TiXmlDocument doc;
doc.SetTabSize( 8 );
doc.Load( "myfile.xml" );
</pre></div><p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classTelEngine_1_1TiXmlBase.html#8b8f21430c62433a48c592277a3bd7a2">Row</a>, <a class="el" href="classTelEngine_1_1TiXmlBase.html#b01a75ed9853cd6e22f06a61d173f229" title="See Row().">Column</a> </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="tinyxml_8h-source.html">tinyxml.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:14 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
619
