pugi::xml_document Class Reference

Inheritance diagram for pugi::xml_document:

[legend]Collaboration diagram for pugi::xml_document:

[legend]List of all members.

---

Detailed Description

Document class (DOM tree root).

This class has noncopyable semantics (private copy ctor/assignment operator).

Public Member Functions
	xml_document ()
	Default ctor, makes empty document.
	~xml_document ()
	Dtor.
bool	load (std::istream &stream, unsigned int options=parse_default)
	Load document from stream.
bool	load (const char *contents, unsigned int options=parse_default)
	Load document from string.
bool	load_file (const char *name, unsigned int options=parse_default)
	Load document from file.
bool	parse (char *xmlstr, unsigned int options=parse_default)
	Parse the given XML string in-situ.
bool	parse (const transfer_ownership_tag &, char *xmlstr, unsigned int options=parse_default)
	Parse the given XML string in-situ (gains ownership).
bool	save_file (const char *name, const char *indent="\t", unsigned int flags=format_default)
	Save XML to file.
void	precompute_document_order ()
	Compute document order for the whole tree Sometimes this makes evaluation of XPath queries faster.

---

Member Function Documentation

bool pugi::xml_document::load (  std::istream &  stream, unsigned int  options = parse_default )

Load document from stream. Parameters: stream  - stream with xml data options  - parsing options Returns: success flag

bool pugi::xml_document::load (  const char *  contents, unsigned int  options = parse_default )

Load document from string. Parameters: contents  - input string options  - parsing options Returns: success flag

bool pugi::xml_document::load_file (  const char *  name, unsigned int  options = parse_default )

Load document from file. Parameters: name  - file name options  - parsing options Returns: success flag

bool pugi::xml_document::parse (  char *  xmlstr, unsigned int  options = parse_default )

Parse the given XML string in-situ. The string is modified; you should ensure that string data will persist throughout the document's lifetime. Although, document does not gain ownership over the string, so you should free the memory occupied by it manually. Parameters: xmlstr  - readwrite string with xml data options  - parsing options Returns: success flag

bool pugi::xml_document::parse (  const transfer_ownership_tag &  , char *  xmlstr, unsigned int  options = parse_default )

Parse the given XML string in-situ (gains ownership). The string is modified; document gains ownership over the string, so you don't have to worry about it's lifetime. Call example: doc.parse(transfer_ownership_tag(), string, options); Parameters: xmlstr  - readwrite string with xml data options  - parsing options Returns: success flag

bool pugi::xml_document::save_file (  const char *  name, const char *  indent = "\t", unsigned int  flags = format_default )

Save XML to file. Parameters: name  - file name indent  - indentation string flags  - formatting flags Returns: success flag

---