A XMLHandle is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that XMLHandle is not part of the TinyXML-2 DOM structure. It is a separate utility class.
Take an example:
<Element attributeA = "valueA">
<Child attributeB = "value1" />
<Child attributeB = "value2" />
Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a lot of code that looks like:
XMLElement* root = document.FirstChildElement( "Document" );
if ( root )
XMLElement* element = root->FirstChildElement( "Element" );
if ( element )
XMLElement* child = element->FirstChildElement( "Child" );
if ( child )
XMLElement* child2 = child->NextSiblingElement( "Child" );
if ( child2 )
// Finally do something useful.
And that doesn't even cover "else" cases. XMLHandle addresses the verbosity of such code. A XMLHandle checks for null pointers so it is perfectly safe and correct to use:
XMLHandle docHandle( &document );
XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement();
if ( child2 )
// do something useful
Which is MUCH more concise and useful.
It is also safe to copy handles - internally they are nothing more than node pointers.
XMLHandle handleCopy = handle;
See also XMLConstHandle, which is the same as XMLHandle, but operates on const objects.
Definition at line 1798 of file tinyxml2.h.