1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xmlns="http://www.w3.org/1999/xhtml"> 3<head> 4<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5<meta http-equiv="X-UA-Compatible" content="IE=9"/> 6<meta name="generator" content="Doxygen 1.9.1"/> 7<meta name="viewport" content="width=device-width, initial-scale=1"/> 8<title>TinyXML-2: tinyxml2::XMLHandle Class Reference</title> 9<link href="tabs.css" rel="stylesheet" type="text/css"/> 10<script type="text/javascript" src="jquery.js"></script> 11<script type="text/javascript" src="dynsections.js"></script> 12<link href="search/search.css" rel="stylesheet" type="text/css"/> 13<script type="text/javascript" src="search/searchdata.js"></script> 14<script type="text/javascript" src="search/search.js"></script> 15<link href="doxygen.css" rel="stylesheet" type="text/css" /> 16</head> 17<body> 18<div id="top"><!-- do not remove this div, it is closed by doxygen! --> 19<div id="titlearea"> 20<table cellspacing="0" cellpadding="0"> 21 <tbody> 22 <tr style="height: 56px;"> 23 <td id="projectalign" style="padding-left: 0.5em;"> 24 <div id="projectname">TinyXML-2 25  <span id="projectnumber">9.0.0</span> 26 </div> 27 </td> 28 </tr> 29 </tbody> 30</table> 31</div> 32<!-- end header part --> 33<!-- Generated by Doxygen 1.9.1 --> 34<script type="text/javascript"> 35/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 36var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); 37/* @license-end */ 38</script> 39<script type="text/javascript" src="menudata.js"></script> 40<script type="text/javascript" src="menu.js"></script> 41<script type="text/javascript"> 42/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ 43$(function() { 44 initMenu('',true,false,'search.php','Search'); 45 $(document).ready(function() { init_search(); }); 46}); 47/* @license-end */</script> 48<div id="main-nav"></div> 49<!-- window showing the filter options --> 50<div id="MSearchSelectWindow" 51 onmouseover="return searchBox.OnSearchSelectShow()" 52 onmouseout="return searchBox.OnSearchSelectHide()" 53 onkeydown="return searchBox.OnSearchSelectKey(event)"> 54</div> 55 56<!-- iframe showing the search results (closed by default) --> 57<div id="MSearchResultsWindow"> 58<iframe src="javascript:void(0)" frameborder="0" 59 name="MSearchResults" id="MSearchResults"> 60</iframe> 61</div> 62 63<div id="nav-path" class="navpath"> 64 <ul> 65<li class="navelem"><b>tinyxml2</b></li><li class="navelem"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a></li> </ul> 66</div> 67</div><!-- top --> 68<div class="header"> 69 <div class="summary"> 70<a href="#pub-methods">Public Member Functions</a> | 71<a href="classtinyxml2_1_1_x_m_l_handle-members.html">List of all members</a> </div> 72 <div class="headertitle"> 73<div class="title">tinyxml2::XMLHandle Class Reference</div> </div> 74</div><!--header--> 75<div class="contents"> 76 77<p><code>#include <<a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a>></code></p> 78<table class="memberdecls"> 79<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> 80Public Member Functions</h2></td></tr> 81<tr class="memitem:a9c240a35c18f053509b4b97ddccd9793"><td class="memItemLeft" align="right" valign="top"><a id="a9c240a35c18f053509b4b97ddccd9793"></a> 82 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a9c240a35c18f053509b4b97ddccd9793">XMLHandle</a> (<a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a> *node)</td></tr> 83<tr class="memdesc:a9c240a35c18f053509b4b97ddccd9793"><td class="mdescLeft"> </td><td class="mdescRight">Create a handle from any node (at any depth of the tree.) This can be a null pointer. <br /></td></tr> 84<tr class="separator:a9c240a35c18f053509b4b97ddccd9793"><td class="memSeparator" colspan="2"> </td></tr> 85<tr class="memitem:aa2edbc1c0d3e3e8259bd98de7f1cf500"><td class="memItemLeft" align="right" valign="top"><a id="aa2edbc1c0d3e3e8259bd98de7f1cf500"></a> 86 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#aa2edbc1c0d3e3e8259bd98de7f1cf500">XMLHandle</a> (<a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a> &node)</td></tr> 87<tr class="memdesc:aa2edbc1c0d3e3e8259bd98de7f1cf500"><td class="mdescLeft"> </td><td class="mdescRight">Create a handle from a node. <br /></td></tr> 88<tr class="separator:aa2edbc1c0d3e3e8259bd98de7f1cf500"><td class="memSeparator" colspan="2"> </td></tr> 89<tr class="memitem:afd8e01e6018c07347b8e6d80272466aa"><td class="memItemLeft" align="right" valign="top"><a id="afd8e01e6018c07347b8e6d80272466aa"></a> 90 </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#afd8e01e6018c07347b8e6d80272466aa">XMLHandle</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> &ref)</td></tr> 91<tr class="memdesc:afd8e01e6018c07347b8e6d80272466aa"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr> 92<tr class="separator:afd8e01e6018c07347b8e6d80272466aa"><td class="memSeparator" colspan="2"> </td></tr> 93<tr class="memitem:a75b908322bb4b83be3281b6845252b20"><td class="memItemLeft" align="right" valign="top"><a id="a75b908322bb4b83be3281b6845252b20"></a> 94<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a75b908322bb4b83be3281b6845252b20">operator=</a> (const <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> &ref)</td></tr> 95<tr class="memdesc:a75b908322bb4b83be3281b6845252b20"><td class="mdescLeft"> </td><td class="mdescRight">Assignment. <br /></td></tr> 96<tr class="separator:a75b908322bb4b83be3281b6845252b20"><td class="memSeparator" colspan="2"> </td></tr> 97<tr class="memitem:a536447dc7f54c0cd11e031dad94795ae"><td class="memItemLeft" align="right" valign="top"><a id="a536447dc7f54c0cd11e031dad94795ae"></a> 98<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a536447dc7f54c0cd11e031dad94795ae">FirstChild</a> ()</td></tr> 99<tr class="memdesc:a536447dc7f54c0cd11e031dad94795ae"><td class="mdescLeft"> </td><td class="mdescRight">Get the first child of this handle. <br /></td></tr> 100<tr class="separator:a536447dc7f54c0cd11e031dad94795ae"><td class="memSeparator" colspan="2"> </td></tr> 101<tr class="memitem:a74b04dd0f15e0bf01860e282b840b6a3"><td class="memItemLeft" align="right" valign="top"><a id="a74b04dd0f15e0bf01860e282b840b6a3"></a> 102<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a74b04dd0f15e0bf01860e282b840b6a3">FirstChildElement</a> (const char *name=0)</td></tr> 103<tr class="memdesc:a74b04dd0f15e0bf01860e282b840b6a3"><td class="mdescLeft"> </td><td class="mdescRight">Get the first child element of this handle. <br /></td></tr> 104<tr class="separator:a74b04dd0f15e0bf01860e282b840b6a3"><td class="memSeparator" colspan="2"> </td></tr> 105<tr class="memitem:a9d09f04435f0f2f7d0816b0198d0517b"><td class="memItemLeft" align="right" valign="top"><a id="a9d09f04435f0f2f7d0816b0198d0517b"></a> 106<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a9d09f04435f0f2f7d0816b0198d0517b">LastChild</a> ()</td></tr> 107<tr class="memdesc:a9d09f04435f0f2f7d0816b0198d0517b"><td class="mdescLeft"> </td><td class="mdescRight">Get the last child of this handle. <br /></td></tr> 108<tr class="separator:a9d09f04435f0f2f7d0816b0198d0517b"><td class="memSeparator" colspan="2"> </td></tr> 109<tr class="memitem:a42cccd0ce8b1ce704f431025e9f19e0c"><td class="memItemLeft" align="right" valign="top"><a id="a42cccd0ce8b1ce704f431025e9f19e0c"></a> 110<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a42cccd0ce8b1ce704f431025e9f19e0c">LastChildElement</a> (const char *name=0)</td></tr> 111<tr class="memdesc:a42cccd0ce8b1ce704f431025e9f19e0c"><td class="mdescLeft"> </td><td class="mdescRight">Get the last child element of this handle. <br /></td></tr> 112<tr class="separator:a42cccd0ce8b1ce704f431025e9f19e0c"><td class="memSeparator" colspan="2"> </td></tr> 113<tr class="memitem:a428374e756f4db4cbc287fec64eae02c"><td class="memItemLeft" align="right" valign="top"><a id="a428374e756f4db4cbc287fec64eae02c"></a> 114<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a428374e756f4db4cbc287fec64eae02c">PreviousSibling</a> ()</td></tr> 115<tr class="memdesc:a428374e756f4db4cbc287fec64eae02c"><td class="mdescLeft"> </td><td class="mdescRight">Get the previous sibling of this handle. <br /></td></tr> 116<tr class="separator:a428374e756f4db4cbc287fec64eae02c"><td class="memSeparator" colspan="2"> </td></tr> 117<tr class="memitem:a786957e498039554ed334cdc36612a7e"><td class="memItemLeft" align="right" valign="top"><a id="a786957e498039554ed334cdc36612a7e"></a> 118<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a786957e498039554ed334cdc36612a7e">PreviousSiblingElement</a> (const char *name=0)</td></tr> 119<tr class="memdesc:a786957e498039554ed334cdc36612a7e"><td class="mdescLeft"> </td><td class="mdescRight">Get the previous sibling element of this handle. <br /></td></tr> 120<tr class="separator:a786957e498039554ed334cdc36612a7e"><td class="memSeparator" colspan="2"> </td></tr> 121<tr class="memitem:aad2eccc7c7c7b18145877c978c3850b5"><td class="memItemLeft" align="right" valign="top"><a id="aad2eccc7c7c7b18145877c978c3850b5"></a> 122<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#aad2eccc7c7c7b18145877c978c3850b5">NextSibling</a> ()</td></tr> 123<tr class="memdesc:aad2eccc7c7c7b18145877c978c3850b5"><td class="mdescLeft"> </td><td class="mdescRight">Get the next sibling of this handle. <br /></td></tr> 124<tr class="separator:aad2eccc7c7c7b18145877c978c3850b5"><td class="memSeparator" colspan="2"> </td></tr> 125<tr class="memitem:ae41d88ee061f3c49a081630ff753b2c5"><td class="memItemLeft" align="right" valign="top"><a id="ae41d88ee061f3c49a081630ff753b2c5"></a> 126<a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#ae41d88ee061f3c49a081630ff753b2c5">NextSiblingElement</a> (const char *name=0)</td></tr> 127<tr class="memdesc:ae41d88ee061f3c49a081630ff753b2c5"><td class="mdescLeft"> </td><td class="mdescRight">Get the next sibling element of this handle. <br /></td></tr> 128<tr class="separator:ae41d88ee061f3c49a081630ff753b2c5"><td class="memSeparator" colspan="2"> </td></tr> 129<tr class="memitem:a03ea6ec970a021b71bf1219a0f6717df"><td class="memItemLeft" align="right" valign="top"><a id="a03ea6ec970a021b71bf1219a0f6717df"></a> 130<a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a03ea6ec970a021b71bf1219a0f6717df">ToNode</a> ()</td></tr> 131<tr class="memdesc:a03ea6ec970a021b71bf1219a0f6717df"><td class="mdescLeft"> </td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_node.html">XMLNode</a>. This can return null. <br /></td></tr> 132<tr class="separator:a03ea6ec970a021b71bf1219a0f6717df"><td class="memSeparator" colspan="2"> </td></tr> 133<tr class="memitem:a5e73ed8f3f6f9619d5a8bb1862c47d99"><td class="memItemLeft" align="right" valign="top"><a id="a5e73ed8f3f6f9619d5a8bb1862c47d99"></a> 134<a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a5e73ed8f3f6f9619d5a8bb1862c47d99">ToElement</a> ()</td></tr> 135<tr class="memdesc:a5e73ed8f3f6f9619d5a8bb1862c47d99"><td class="mdescLeft"> </td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_element.html">XMLElement</a>. This can return null. <br /></td></tr> 136<tr class="separator:a5e73ed8f3f6f9619d5a8bb1862c47d99"><td class="memSeparator" colspan="2"> </td></tr> 137<tr class="memitem:a6ab9e8cbfb41417246e5657e3842c62a"><td class="memItemLeft" align="right" valign="top"><a id="a6ab9e8cbfb41417246e5657e3842c62a"></a> 138<a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a6ab9e8cbfb41417246e5657e3842c62a">ToText</a> ()</td></tr> 139<tr class="memdesc:a6ab9e8cbfb41417246e5657e3842c62a"><td class="mdescLeft"> </td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_text.html">XMLText</a>. This can return null. <br /></td></tr> 140<tr class="separator:a6ab9e8cbfb41417246e5657e3842c62a"><td class="memSeparator" colspan="2"> </td></tr> 141<tr class="memitem:aa387368a1ad8d843a9f12df863d298de"><td class="memItemLeft" align="right" valign="top"><a id="aa387368a1ad8d843a9f12df863d298de"></a> 142<a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#aa387368a1ad8d843a9f12df863d298de">ToUnknown</a> ()</td></tr> 143<tr class="memdesc:aa387368a1ad8d843a9f12df863d298de"><td class="mdescLeft"> </td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_unknown.html">XMLUnknown</a>. This can return null. <br /></td></tr> 144<tr class="separator:aa387368a1ad8d843a9f12df863d298de"><td class="memSeparator" colspan="2"> </td></tr> 145<tr class="memitem:a108858be7ee3eb53f73b5194c1aa8ff0"><td class="memItemLeft" align="right" valign="top"><a id="a108858be7ee3eb53f73b5194c1aa8ff0"></a> 146<a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classtinyxml2_1_1_x_m_l_handle.html#a108858be7ee3eb53f73b5194c1aa8ff0">ToDeclaration</a> ()</td></tr> 147<tr class="memdesc:a108858be7ee3eb53f73b5194c1aa8ff0"><td class="mdescLeft"> </td><td class="mdescRight">Safe cast to <a class="el" href="classtinyxml2_1_1_x_m_l_declaration.html">XMLDeclaration</a>. This can return null. <br /></td></tr> 148<tr class="separator:a108858be7ee3eb53f73b5194c1aa8ff0"><td class="memSeparator" colspan="2"> </td></tr> 149</table> 150<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> 151<div class="textblock"><p>A <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> is a class that wraps a node pointer with null checks; this is an incredibly useful thing. Note that <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> is not part of the TinyXML-2 DOM structure. It is a separate utility class.</p> 152<p>Take an example: </p><pre class="fragment"><Document> 153 <Element attributeA = "valueA"> 154 <Child attributeB = "value1" /> 155 <Child attributeB = "value2" /> 156 </Element> 157</Document> 158</pre><p>Assuming you want the value of "attributeB" in the 2nd "Child" element, it's very easy to write a <em>lot</em> of code that looks like:</p> 159<pre class="fragment">XMLElement* root = document.FirstChildElement( "Document" ); 160if ( root ) 161{ 162 XMLElement* element = root->FirstChildElement( "Element" ); 163 if ( element ) 164 { 165 XMLElement* child = element->FirstChildElement( "Child" ); 166 if ( child ) 167 { 168 XMLElement* child2 = child->NextSiblingElement( "Child" ); 169 if ( child2 ) 170 { 171 // Finally do something useful. 172</pre><p>And that doesn't even cover "else" cases. <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> addresses the verbosity of such code. A <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a> checks for null pointers so it is perfectly safe and correct to use:</p> 173<pre class="fragment">XMLHandle docHandle( &document ); 174XMLElement* child2 = docHandle.FirstChildElement( "Document" ).FirstChildElement( "Element" ).FirstChildElement().NextSiblingElement(); 175if ( child2 ) 176{ 177 // do something useful 178</pre><p>Which is MUCH more concise and useful.</p> 179<p>It is also safe to copy handles - internally they are nothing more than node pointers. </p><pre class="fragment">XMLHandle handleCopy = handle; 180</pre><p>See also <a class="el" href="classtinyxml2_1_1_x_m_l_const_handle.html">XMLConstHandle</a>, which is the same as <a class="el" href="classtinyxml2_1_1_x_m_l_handle.html">XMLHandle</a>, but operates on const objects. </p> 181</div><hr/>The documentation for this class was generated from the following file:<ul> 182<li><a class="el" href="tinyxml2_8h_source.html">tinyxml2.h</a></li> 183</ul> 184</div><!-- contents --> 185<!-- start footer part --> 186<hr class="footer"/><address class="footer"><small> 187Generated on Sun Jun 6 2021 17:10:05 for TinyXML-2 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 188</small></address> 189</body> 190</html> 191
