# TiXmlDocument¶

class TiXmlDocument

Bases: TiXmlNode

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.

Inheritance diagram

void ClearError(void)

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.

bool Error(void) const

If an error occurs, Error will be set to true. Also, - The ErrorId() will contain the integer identifier of the error (not generally useful) - The ErrorDesc() method will return the name of the error. (very useful) - The ErrorRow() and ErrorCol() will return the location of the error (if known)

int ErrorCol(void) const

///< The column where the error occured. See ErrorRow()

char const *ErrorDesc(void) const

/// Contains a textual (english) description of the error if one occurs.

int ErrorId(void) const

Generally, you probably want the error string ( ErrorDesc() ). But if you prefer the ErrorId, this function will fetch it.

int ErrorRow(void) const

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.)

See also TiXmlDocument::SetTabSize(), :cpp:obj: Row, :cpp:obj: Column.

bool LoadFile(TiXmlEncoding encoding = ::TIXML_DEFAULT_ENCODING)
bool LoadFile(char const *filename, TiXmlEncoding encoding = ::TIXML_DEFAULT_ENCODING)
bool LoadFile(FILE*, TiXmlEncoding encoding = ::TIXML_DEFAULT_ENCODING)
bool LoadFile(std::string const &filename, TiXmlEncoding encoding = ::TIXML_DEFAULT_ENCODING)

Load a file using the current document value. Returns true if successful. Will delete any existing document data before loading.

Load a file using the given filename. Returns true if successful.

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.

STL std::string version.

void Print(void) const

Write the document to standard out using formatted printing (“pretty print”). */

TiXmlElement const *RootElement(void) const
TiXmlElement *RootElement(void)

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.

bool SaveFile(void) const
bool SaveFile(char const *filename) const
bool SaveFile(FILE*) const
bool SaveFile(std::string const &filename) const

/// Save a file using the current document value. Returns true if successful.

/// Save a file using the given filename. Returns true if successful.

/// Save a file using the given FILE*. Returns true if successful.

///< STL std::string version.

void SetError(int err, char const *errorLocation, TiXmlParsingData *prevData, TiXmlEncoding encoding)

[internal use]

void SetTabSize(int _tabsize)

SetTabSize() allows the error reporting functions (ErrorRow() and ErrorCol()) to report the correct values for row and column. It does not change the output or input in any way.

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.

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.

Note that row and column tracking is not supported when using operator>>.

The tab size needs to be enabled before the parse or load. Correct usage:

TiXmlDocument doc;
doc.SetTabSize( 8 );


See also :cpp:obj:Row, :cpp:obj: Column.

int TabSize(void) const
TiXmlDocument(void)
TiXmlDocument(char const *documentName)
TiXmlDocument(std::string const &documentName)
TiXmlDocument(TiXmlDocument const &copy)

/// Create an empty document, that has no name.

/// Create a document with a name. The name of the document is also the filename of the xml.

/// Constructor.