doc/html/group__nodes.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8.14"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>yaml: Nodes</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="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">yaml
  22    &#160;<span id="projectnumber">0.2.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.14 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Data Structures</a> &#124;
  44 <a href="#define-members">Macros</a> &#124;
  45 <a href="#typedef-members">Typedefs</a> &#124;
  46 <a href="#enum-members">Enumerations</a> &#124;
  47 <a href="#func-members">Functions</a>  </div>
  48   <div class="headertitle">
  49 <div class="title">Nodes</div>  </div>
  50 </div><!--header-->
  51 <div class="contents">
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  54 Data Structures</h2></td></tr>
  55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a></td></tr>
  56 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An element of a mapping node.  <a href="structyaml__node__pair__s.html#details">More...</a><br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html">yaml_node_s</a></td></tr>
  59 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The node structure.  <a href="structyaml__node__s.html#details">More...</a><br /></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html">yaml_document_s</a></td></tr>
  62 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The document structure.  <a href="structyaml__document__s.html#details">More...</a><br /></td></tr>
  63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 </table><table class="memberdecls">
  65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  66 Macros</h2></td></tr>
  67 <tr class="memitem:gadfa882b6e42a3a993d12392d55260b00"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gadfa882b6e42a3a993d12392d55260b00">YAML_NULL_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:null&quot;</td></tr>
  68 <tr class="memdesc:gadfa882b6e42a3a993d12392d55260b00"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!null</code> with the only possible value: <code>null</code>.  <a href="#gadfa882b6e42a3a993d12392d55260b00">More...</a><br /></td></tr>
  69 <tr class="separator:gadfa882b6e42a3a993d12392d55260b00"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:ga312629a1f51e91b136352db988d4d771"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga312629a1f51e91b136352db988d4d771">YAML_BOOL_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:bool&quot;</td></tr>
  71 <tr class="memdesc:ga312629a1f51e91b136352db988d4d771"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!bool</code> with the values: <code>true</code> and <code>false</code>.  <a href="#ga312629a1f51e91b136352db988d4d771">More...</a><br /></td></tr>
  72 <tr class="separator:ga312629a1f51e91b136352db988d4d771"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:gac5dbc6d1f556663edf8db88d6113e931"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:str&quot;</td></tr>
  74 <tr class="memdesc:gac5dbc6d1f556663edf8db88d6113e931"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!str</code> for string values.  <a href="#gac5dbc6d1f556663edf8db88d6113e931">More...</a><br /></td></tr>
  75 <tr class="separator:gac5dbc6d1f556663edf8db88d6113e931"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76 <tr class="memitem:ga83263cdb4ffa6ad2f7d9a87281979ff5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga83263cdb4ffa6ad2f7d9a87281979ff5">YAML_INT_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:int&quot;</td></tr>
  77 <tr class="memdesc:ga83263cdb4ffa6ad2f7d9a87281979ff5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!int</code> for integer values.  <a href="#ga83263cdb4ffa6ad2f7d9a87281979ff5">More...</a><br /></td></tr>
  78 <tr class="separator:ga83263cdb4ffa6ad2f7d9a87281979ff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:ga6ab2ec71fc47cb24f1003b9acdb92843"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga6ab2ec71fc47cb24f1003b9acdb92843">YAML_FLOAT_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:float&quot;</td></tr>
  80 <tr class="memdesc:ga6ab2ec71fc47cb24f1003b9acdb92843"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!float</code> for float values.  <a href="#ga6ab2ec71fc47cb24f1003b9acdb92843">More...</a><br /></td></tr>
  81 <tr class="separator:ga6ab2ec71fc47cb24f1003b9acdb92843"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:ga3e27cca7191234f2e8c95eaf3bc99a73"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga3e27cca7191234f2e8c95eaf3bc99a73">YAML_TIMESTAMP_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:timestamp&quot;</td></tr>
  83 <tr class="memdesc:ga3e27cca7191234f2e8c95eaf3bc99a73"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!timestamp</code> for date and time values.  <a href="#ga3e27cca7191234f2e8c95eaf3bc99a73">More...</a><br /></td></tr>
  84 <tr class="separator:ga3e27cca7191234f2e8c95eaf3bc99a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:gaa8284b30f9c9e3f10f6a69c9b882f417"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:seq&quot;</td></tr>
  86 <tr class="memdesc:gaa8284b30f9c9e3f10f6a69c9b882f417"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!seq</code> is used to denote sequences.  <a href="#gaa8284b30f9c9e3f10f6a69c9b882f417">More...</a><br /></td></tr>
  87 <tr class="separator:gaa8284b30f9c9e3f10f6a69c9b882f417"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 <tr class="memitem:ga22ae99cf3ac014dd76873268fd068c12"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a>&#160;&#160;&#160;&quot;tag:yaml.org,2002:map&quot;</td></tr>
  89 <tr class="memdesc:ga22ae99cf3ac014dd76873268fd068c12"><td class="mdescLeft">&#160;</td><td class="mdescRight">The tag <code>!!map</code> is used to denote mapping.  <a href="#ga22ae99cf3ac014dd76873268fd068c12">More...</a><br /></td></tr>
  90 <tr class="separator:ga22ae99cf3ac014dd76873268fd068c12"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91 <tr class="memitem:gaf6b0c4e819b8f6915515a4f70065aaaa"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf6b0c4e819b8f6915515a4f70065aaaa">YAML_DEFAULT_SCALAR_TAG</a>&#160;&#160;&#160;<a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a></td></tr>
  92 <tr class="memdesc:gaf6b0c4e819b8f6915515a4f70065aaaa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default scalar tag is <code>!!str</code>.  <a href="#gaf6b0c4e819b8f6915515a4f70065aaaa">More...</a><br /></td></tr>
  93 <tr class="separator:gaf6b0c4e819b8f6915515a4f70065aaaa"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94 <tr class="memitem:gaf195b67002518702e27746d6b4da6124"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf195b67002518702e27746d6b4da6124">YAML_DEFAULT_SEQUENCE_TAG</a>&#160;&#160;&#160;<a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a></td></tr>
  95 <tr class="memdesc:gaf195b67002518702e27746d6b4da6124"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default sequence tag is <code>!!seq</code>.  <a href="#gaf195b67002518702e27746d6b4da6124">More...</a><br /></td></tr>
  96 <tr class="separator:gaf195b67002518702e27746d6b4da6124"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97 <tr class="memitem:gaf7b1f8f0ce5665794510cd3841802a5f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf7b1f8f0ce5665794510cd3841802a5f">YAML_DEFAULT_MAPPING_TAG</a>&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a></td></tr>
  98 <tr class="memdesc:gaf7b1f8f0ce5665794510cd3841802a5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The default mapping tag is <code>!!map</code>.  <a href="#gaf7b1f8f0ce5665794510cd3841802a5f">More...</a><br /></td></tr>
  99 <tr class="separator:gaf7b1f8f0ce5665794510cd3841802a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 100 </table><table class="memberdecls">
 101 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
 102 Typedefs</h2></td></tr>
 103 <tr class="memitem:gabe020d2fc42d3e896549e9f97da622d2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td></tr>
 104 <tr class="memdesc:gabe020d2fc42d3e896549e9f97da622d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node types.  <a href="#gabe020d2fc42d3e896549e9f97da622d2">More...</a><br /></td></tr>
 105 <tr class="separator:gabe020d2fc42d3e896549e9f97da622d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 106 <tr class="memitem:ga9eaaa233b120b9d9db47de93c294c40f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td></tr>
 107 <tr class="memdesc:ga9eaaa233b120b9d9db47de93c294c40f"><td class="mdescLeft">&#160;</td><td class="mdescRight">The forward definition of a document node structure.  <a href="#ga9eaaa233b120b9d9db47de93c294c40f">More...</a><br /></td></tr>
 108 <tr class="separator:ga9eaaa233b120b9d9db47de93c294c40f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 109 <tr class="memitem:ga7cc3581582e778b00c04e99cd3656860"><td class="memItemLeft" align="right" valign="top">typedef int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td></tr>
 110 <tr class="memdesc:ga7cc3581582e778b00c04e99cd3656860"><td class="mdescLeft">&#160;</td><td class="mdescRight">An element of a sequence node.  <a href="#ga7cc3581582e778b00c04e99cd3656860">More...</a><br /></td></tr>
 111 <tr class="separator:ga7cc3581582e778b00c04e99cd3656860"><td class="memSeparator" colspan="2">&#160;</td></tr>
 112 <tr class="memitem:ga90f1c8b83c5c38dc4016afc1cc2050c4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td></tr>
 113 <tr class="memdesc:ga90f1c8b83c5c38dc4016afc1cc2050c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">An element of a mapping node.  <a href="#ga90f1c8b83c5c38dc4016afc1cc2050c4">More...</a><br /></td></tr>
 114 <tr class="separator:ga90f1c8b83c5c38dc4016afc1cc2050c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 115 <tr class="memitem:gad94e064e95baeb22e4f7acc7804e8479"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td></tr>
 116 <tr class="memdesc:gad94e064e95baeb22e4f7acc7804e8479"><td class="mdescLeft">&#160;</td><td class="mdescRight">The document structure.  <a href="#gad94e064e95baeb22e4f7acc7804e8479">More...</a><br /></td></tr>
 117 <tr class="separator:gad94e064e95baeb22e4f7acc7804e8479"><td class="memSeparator" colspan="2">&#160;</td></tr>
 118 </table><table class="memberdecls">
 119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
 120 Enumerations</h2></td></tr>
 121 <tr class="memitem:ga0897d4b6bdd1b56c7a5fa0ff17b4f798"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> { <br />
 122 &#160;&#160;<a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739">YAML_NO_NODE</a>,
 123 <br />
 124 &#160;&#160;<a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45">YAML_SCALAR_NODE</a>,
 125 <br />
 126 &#160;&#160;<a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15">YAML_SEQUENCE_NODE</a>,
 127 <br />
 128 &#160;&#160;<a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6">YAML_MAPPING_NODE</a>
 129 <br />
 130  }</td></tr>
 131 <tr class="memdesc:ga0897d4b6bdd1b56c7a5fa0ff17b4f798"><td class="mdescLeft">&#160;</td><td class="mdescRight">Node types.  <a href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">More...</a><br /></td></tr>
 132 <tr class="separator:ga0897d4b6bdd1b56c7a5fa0ff17b4f798"><td class="memSeparator" colspan="2">&#160;</td></tr>
 133 </table><table class="memberdecls">
 134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
 135 Functions</h2></td></tr>
 136 <tr class="memitem:ga62a485c96f3b7962436a0da5e6f3cc89"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89">yaml_document_initialize</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *version_directive, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_end, int start_implicit, int end_implicit)</td></tr>
 137 <tr class="memdesc:ga62a485c96f3b7962436a0da5e6f3cc89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a YAML document.  <a href="#ga62a485c96f3b7962436a0da5e6f3cc89">More...</a><br /></td></tr>
 138 <tr class="separator:ga62a485c96f3b7962436a0da5e6f3cc89"><td class="memSeparator" colspan="2">&#160;</td></tr>
 139 <tr class="memitem:ga2754b1544fb4e110e83fafbc708b0672"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga2754b1544fb4e110e83fafbc708b0672">yaml_document_delete</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
 140 <tr class="memdesc:ga2754b1544fb4e110e83fafbc708b0672"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete a YAML document and all its nodes.  <a href="#ga2754b1544fb4e110e83fafbc708b0672">More...</a><br /></td></tr>
 141 <tr class="separator:ga2754b1544fb4e110e83fafbc708b0672"><td class="memSeparator" colspan="2">&#160;</td></tr>
 142 <tr class="memitem:gafa1feabc9747dbded4dca24e27d3c21a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gafa1feabc9747dbded4dca24e27d3c21a">yaml_document_get_node</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int index)</td></tr>
 143 <tr class="memdesc:gafa1feabc9747dbded4dca24e27d3c21a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a node of a YAML document.  <a href="#gafa1feabc9747dbded4dca24e27d3c21a">More...</a><br /></td></tr>
 144 <tr class="separator:gafa1feabc9747dbded4dca24e27d3c21a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <tr class="memitem:ga40eeaa68fb2f3be34c4fe34e7597d324"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga40eeaa68fb2f3be34c4fe34e7597d324">yaml_document_get_root_node</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
 146 <tr class="memdesc:ga40eeaa68fb2f3be34c4fe34e7597d324"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the root of a YAML document node.  <a href="#ga40eeaa68fb2f3be34c4fe34e7597d324">More...</a><br /></td></tr>
 147 <tr class="separator:ga40eeaa68fb2f3be34c4fe34e7597d324"><td class="memSeparator" colspan="2">&#160;</td></tr>
 148 <tr class="memitem:ga45dab8b983b58a005557d4b01f5057b0"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga45dab8b983b58a005557d4b01f5057b0">yaml_document_add_scalar</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr>
 149 <tr class="memdesc:ga45dab8b983b58a005557d4b01f5057b0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SCALAR node and attach it to the document.  <a href="#ga45dab8b983b58a005557d4b01f5057b0">More...</a><br /></td></tr>
 150 <tr class="separator:ga45dab8b983b58a005557d4b01f5057b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
 151 <tr class="memitem:ga83b2f7fdd9a439397a42016bddad7786"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga83b2f7fdd9a439397a42016bddad7786">yaml_document_add_sequence</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr>
 152 <tr class="memdesc:ga83b2f7fdd9a439397a42016bddad7786"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SEQUENCE node and attach it to the document.  <a href="#ga83b2f7fdd9a439397a42016bddad7786">More...</a><br /></td></tr>
 153 <tr class="separator:ga83b2f7fdd9a439397a42016bddad7786"><td class="memSeparator" colspan="2">&#160;</td></tr>
 154 <tr class="memitem:ga45a9f8288704f99cd81dc5cb31329d34"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga45a9f8288704f99cd81dc5cb31329d34">yaml_document_add_mapping</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr>
 155 <tr class="memdesc:ga45a9f8288704f99cd81dc5cb31329d34"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a MAPPING node and attach it to the document.  <a href="#ga45a9f8288704f99cd81dc5cb31329d34">More...</a><br /></td></tr>
 156 <tr class="separator:ga45a9f8288704f99cd81dc5cb31329d34"><td class="memSeparator" colspan="2">&#160;</td></tr>
 157 <tr class="memitem:ga16435917cd6c0261cd390fa8cf173b1b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga16435917cd6c0261cd390fa8cf173b1b">yaml_document_append_sequence_item</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int sequence, int item)</td></tr>
 158 <tr class="memdesc:ga16435917cd6c0261cd390fa8cf173b1b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add an item to a SEQUENCE node.  <a href="#ga16435917cd6c0261cd390fa8cf173b1b">More...</a><br /></td></tr>
 159 <tr class="separator:ga16435917cd6c0261cd390fa8cf173b1b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 160 <tr class="memitem:ga2db27002d8a9ae06b1729d0ee06553d2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga2db27002d8a9ae06b1729d0ee06553d2">yaml_document_append_mapping_pair</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int mapping, int key, int value)</td></tr>
 161 <tr class="memdesc:ga2db27002d8a9ae06b1729d0ee06553d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a pair of a key and a value to a MAPPING node.  <a href="#ga2db27002d8a9ae06b1729d0ee06553d2">More...</a><br /></td></tr>
 162 <tr class="separator:ga2db27002d8a9ae06b1729d0ee06553d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 163 </table>
 164 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 165 <h2 class="groupheader">Macro Definition Documentation</h2>
 166 <a id="gadfa882b6e42a3a993d12392d55260b00"></a>
 167 <h2 class="memtitle"><span class="permalink"><a href="#gadfa882b6e42a3a993d12392d55260b00">&#9670;&nbsp;</a></span>YAML_NULL_TAG</h2>
 168
 169 <div class="memitem">
 170 <div class="memproto">
 171       <table class="memname">
 172         <tr>
 173           <td class="memname">#define YAML_NULL_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:null&quot;</td>
 174         </tr>
 175       </table>
 176 </div><div class="memdoc">
 177
 178 <p>The tag <code>!!null</code> with the only possible value: <code>null</code>. </p>
 179
 180 </div>
 181 </div>
 182 <a id="ga312629a1f51e91b136352db988d4d771"></a>
 183 <h2 class="memtitle"><span class="permalink"><a href="#ga312629a1f51e91b136352db988d4d771">&#9670;&nbsp;</a></span>YAML_BOOL_TAG</h2>
 184
 185 <div class="memitem">
 186 <div class="memproto">
 187       <table class="memname">
 188         <tr>
 189           <td class="memname">#define YAML_BOOL_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:bool&quot;</td>
 190         </tr>
 191       </table>
 192 </div><div class="memdoc">
 193
 194 <p>The tag <code>!!bool</code> with the values: <code>true</code> and <code>false</code>. </p>
 195
 196 </div>
 197 </div>
 198 <a id="gac5dbc6d1f556663edf8db88d6113e931"></a>
 199 <h2 class="memtitle"><span class="permalink"><a href="#gac5dbc6d1f556663edf8db88d6113e931">&#9670;&nbsp;</a></span>YAML_STR_TAG</h2>
 200
 201 <div class="memitem">
 202 <div class="memproto">
 203       <table class="memname">
 204         <tr>
 205           <td class="memname">#define YAML_STR_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:str&quot;</td>
 206         </tr>
 207       </table>
 208 </div><div class="memdoc">
 209
 210 <p>The tag <code>!!str</code> for string values. </p>
 211
 212 </div>
 213 </div>
 214 <a id="ga83263cdb4ffa6ad2f7d9a87281979ff5"></a>
 215 <h2 class="memtitle"><span class="permalink"><a href="#ga83263cdb4ffa6ad2f7d9a87281979ff5">&#9670;&nbsp;</a></span>YAML_INT_TAG</h2>
 216
 217 <div class="memitem">
 218 <div class="memproto">
 219       <table class="memname">
 220         <tr>
 221           <td class="memname">#define YAML_INT_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:int&quot;</td>
 222         </tr>
 223       </table>
 224 </div><div class="memdoc">
 225
 226 <p>The tag <code>!!int</code> for integer values. </p>
 227
 228 </div>
 229 </div>
 230 <a id="ga6ab2ec71fc47cb24f1003b9acdb92843"></a>
 231 <h2 class="memtitle"><span class="permalink"><a href="#ga6ab2ec71fc47cb24f1003b9acdb92843">&#9670;&nbsp;</a></span>YAML_FLOAT_TAG</h2>
 232
 233 <div class="memitem">
 234 <div class="memproto">
 235       <table class="memname">
 236         <tr>
 237           <td class="memname">#define YAML_FLOAT_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:float&quot;</td>
 238         </tr>
 239       </table>
 240 </div><div class="memdoc">
 241
 242 <p>The tag <code>!!float</code> for float values. </p>
 243
 244 </div>
 245 </div>
 246 <a id="ga3e27cca7191234f2e8c95eaf3bc99a73"></a>
 247 <h2 class="memtitle"><span class="permalink"><a href="#ga3e27cca7191234f2e8c95eaf3bc99a73">&#9670;&nbsp;</a></span>YAML_TIMESTAMP_TAG</h2>
 248
 249 <div class="memitem">
 250 <div class="memproto">
 251       <table class="memname">
 252         <tr>
 253           <td class="memname">#define YAML_TIMESTAMP_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:timestamp&quot;</td>
 254         </tr>
 255       </table>
 256 </div><div class="memdoc">
 257
 258 <p>The tag <code>!!timestamp</code> for date and time values. </p>
 259
 260 </div>
 261 </div>
 262 <a id="gaa8284b30f9c9e3f10f6a69c9b882f417"></a>
 263 <h2 class="memtitle"><span class="permalink"><a href="#gaa8284b30f9c9e3f10f6a69c9b882f417">&#9670;&nbsp;</a></span>YAML_SEQ_TAG</h2>
 264
 265 <div class="memitem">
 266 <div class="memproto">
 267       <table class="memname">
 268         <tr>
 269           <td class="memname">#define YAML_SEQ_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:seq&quot;</td>
 270         </tr>
 271       </table>
 272 </div><div class="memdoc">
 273
 274 <p>The tag <code>!!seq</code> is used to denote sequences. </p>
 275
 276 </div>
 277 </div>
 278 <a id="ga22ae99cf3ac014dd76873268fd068c12"></a>
 279 <h2 class="memtitle"><span class="permalink"><a href="#ga22ae99cf3ac014dd76873268fd068c12">&#9670;&nbsp;</a></span>YAML_MAP_TAG</h2>
 280
 281 <div class="memitem">
 282 <div class="memproto">
 283       <table class="memname">
 284         <tr>
 285           <td class="memname">#define YAML_MAP_TAG&#160;&#160;&#160;&quot;tag:yaml.org,2002:map&quot;</td>
 286         </tr>
 287       </table>
 288 </div><div class="memdoc">
 289
 290 <p>The tag <code>!!map</code> is used to denote mapping. </p>
 291
 292 </div>
 293 </div>
 294 <a id="gaf6b0c4e819b8f6915515a4f70065aaaa"></a>
 295 <h2 class="memtitle"><span class="permalink"><a href="#gaf6b0c4e819b8f6915515a4f70065aaaa">&#9670;&nbsp;</a></span>YAML_DEFAULT_SCALAR_TAG</h2>
 296
 297 <div class="memitem">
 298 <div class="memproto">
 299       <table class="memname">
 300         <tr>
 301           <td class="memname">#define YAML_DEFAULT_SCALAR_TAG&#160;&#160;&#160;<a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a></td>
 302         </tr>
 303       </table>
 304 </div><div class="memdoc">
 305
 306 <p>The default scalar tag is <code>!!str</code>. </p>
 307
 308 </div>
 309 </div>
 310 <a id="gaf195b67002518702e27746d6b4da6124"></a>
 311 <h2 class="memtitle"><span class="permalink"><a href="#gaf195b67002518702e27746d6b4da6124">&#9670;&nbsp;</a></span>YAML_DEFAULT_SEQUENCE_TAG</h2>
 312
 313 <div class="memitem">
 314 <div class="memproto">
 315       <table class="memname">
 316         <tr>
 317           <td class="memname">#define YAML_DEFAULT_SEQUENCE_TAG&#160;&#160;&#160;<a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a></td>
 318         </tr>
 319       </table>
 320 </div><div class="memdoc">
 321
 322 <p>The default sequence tag is <code>!!seq</code>. </p>
 323
 324 </div>
 325 </div>
 326 <a id="gaf7b1f8f0ce5665794510cd3841802a5f"></a>
 327 <h2 class="memtitle"><span class="permalink"><a href="#gaf7b1f8f0ce5665794510cd3841802a5f">&#9670;&nbsp;</a></span>YAML_DEFAULT_MAPPING_TAG</h2>
 328
 329 <div class="memitem">
 330 <div class="memproto">
 331       <table class="memname">
 332         <tr>
 333           <td class="memname">#define YAML_DEFAULT_MAPPING_TAG&#160;&#160;&#160;<a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a></td>
 334         </tr>
 335       </table>
 336 </div><div class="memdoc">
 337
 338 <p>The default mapping tag is <code>!!map</code>. </p>
 339
 340 </div>
 341 </div>
 342 <h2 class="groupheader">Typedef Documentation</h2>
 343 <a id="gabe020d2fc42d3e896549e9f97da622d2"></a>
 344 <h2 class="memtitle"><span class="permalink"><a href="#gabe020d2fc42d3e896549e9f97da622d2">&#9670;&nbsp;</a></span>yaml_node_type_t</h2>
 345
 346 <div class="memitem">
 347 <div class="memproto">
 348       <table class="memname">
 349         <tr>
 350           <td class="memname">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a>  <a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td>
 351         </tr>
 352       </table>
 353 </div><div class="memdoc">
 354
 355 <p>Node types. </p>
 356
 357 </div>
 358 </div>
 359 <a id="ga9eaaa233b120b9d9db47de93c294c40f"></a>
 360 <h2 class="memtitle"><span class="permalink"><a href="#ga9eaaa233b120b9d9db47de93c294c40f">&#9670;&nbsp;</a></span>yaml_node_t</h2>
 361
 362 <div class="memitem">
 363 <div class="memproto">
 364       <table class="memname">
 365         <tr>
 366           <td class="memname">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> <a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td>
 367         </tr>
 368       </table>
 369 </div><div class="memdoc">
 370
 371 <p>The forward definition of a document node structure. </p>
 372
 373 </div>
 374 </div>
 375 <a id="ga7cc3581582e778b00c04e99cd3656860"></a>
 376 <h2 class="memtitle"><span class="permalink"><a href="#ga7cc3581582e778b00c04e99cd3656860">&#9670;&nbsp;</a></span>yaml_node_item_t</h2>
 377
 378 <div class="memitem">
 379 <div class="memproto">
 380       <table class="memname">
 381         <tr>
 382           <td class="memname">typedef int <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td>
 383         </tr>
 384       </table>
 385 </div><div class="memdoc">
 386
 387 <p>An element of a sequence node. </p>
 388
 389 </div>
 390 </div>
 391 <a id="ga90f1c8b83c5c38dc4016afc1cc2050c4"></a>
 392 <h2 class="memtitle"><span class="permalink"><a href="#ga90f1c8b83c5c38dc4016afc1cc2050c4">&#9670;&nbsp;</a></span>yaml_node_pair_t</h2>
 393
 394 <div class="memitem">
 395 <div class="memproto">
 396       <table class="memname">
 397         <tr>
 398           <td class="memname">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a>  <a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td>
 399         </tr>
 400       </table>
 401 </div><div class="memdoc">
 402
 403 <p>An element of a mapping node. </p>
 404
 405 </div>
 406 </div>
 407 <a id="gad94e064e95baeb22e4f7acc7804e8479"></a>
 408 <h2 class="memtitle"><span class="permalink"><a href="#gad94e064e95baeb22e4f7acc7804e8479">&#9670;&nbsp;</a></span>yaml_document_t</h2>
 409
 410 <div class="memitem">
 411 <div class="memproto">
 412       <table class="memname">
 413         <tr>
 414           <td class="memname">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a>  <a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td>
 415         </tr>
 416       </table>
 417 </div><div class="memdoc">
 418
 419 <p>The document structure. </p>
 420
 421 </div>
 422 </div>
 423 <h2 class="groupheader">Enumeration Type Documentation</h2>
 424 <a id="ga0897d4b6bdd1b56c7a5fa0ff17b4f798"></a>
 425 <h2 class="memtitle"><span class="permalink"><a href="#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">&#9670;&nbsp;</a></span>yaml_node_type_e</h2>
 426
 427 <div class="memitem">
 428 <div class="memproto">
 429       <table class="memname">
 430         <tr>
 431           <td class="memname">enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a></td>
 432         </tr>
 433       </table>
 434 </div><div class="memdoc">
 435
 436 <p>Node types. </p>
 437 <table class="fieldtable">
 438 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739"></a>YAML_NO_NODE&#160;</td><td class="fielddoc"><p>An empty node. </p>
 439 </td></tr>
 440 <tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45"></a>YAML_SCALAR_NODE&#160;</td><td class="fielddoc"><p>A scalar node. </p>
 441 </td></tr>
 442 <tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15"></a>YAML_SEQUENCE_NODE&#160;</td><td class="fielddoc"><p>A sequence node. </p>
 443 </td></tr>
 444 <tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6"></a>YAML_MAPPING_NODE&#160;</td><td class="fielddoc"><p>A mapping node. </p>
 445 </td></tr>
 446 </table>
 447
 448 </div>
 449 </div>
 450 <h2 class="groupheader">Function Documentation</h2>
 451 <a id="ga62a485c96f3b7962436a0da5e6f3cc89"></a>
 452 <h2 class="memtitle"><span class="permalink"><a href="#ga62a485c96f3b7962436a0da5e6f3cc89">&#9670;&nbsp;</a></span>yaml_document_initialize()</h2>
 453
 454 <div class="memitem">
 455 <div class="memproto">
 456       <table class="memname">
 457         <tr>
 458           <td class="memname">int yaml_document_initialize </td>
 459           <td>(</td>
 460           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 461           <td class="paramname"><em>document</em>, </td>
 462         </tr>
 463         <tr>
 464           <td class="paramkey"></td>
 465           <td></td>
 466           <td class="paramtype"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *&#160;</td>
 467           <td class="paramname"><em>version_directive</em>, </td>
 468         </tr>
 469         <tr>
 470           <td class="paramkey"></td>
 471           <td></td>
 472           <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;</td>
 473           <td class="paramname"><em>tag_directives_start</em>, </td>
 474         </tr>
 475         <tr>
 476           <td class="paramkey"></td>
 477           <td></td>
 478           <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;</td>
 479           <td class="paramname"><em>tag_directives_end</em>, </td>
 480         </tr>
 481         <tr>
 482           <td class="paramkey"></td>
 483           <td></td>
 484           <td class="paramtype">int&#160;</td>
 485           <td class="paramname"><em>start_implicit</em>, </td>
 486         </tr>
 487         <tr>
 488           <td class="paramkey"></td>
 489           <td></td>
 490           <td class="paramtype">int&#160;</td>
 491           <td class="paramname"><em>end_implicit</em>&#160;</td>
 492         </tr>
 493         <tr>
 494           <td></td>
 495           <td>)</td>
 496           <td></td><td></td>
 497         </tr>
 498       </table>
 499 </div><div class="memdoc">
 500
 501 <p>Create a YAML document. </p>
 502 <dl class="params"><dt>Parameters</dt><dd>
 503   <table class="params">
 504     <tr><td class="paramdir">[out]</td><td class="paramname">document</td><td>An empty document object. </td></tr>
 505     <tr><td class="paramdir">[in]</td><td class="paramname">version_directive</td><td>The YAML directive value or <code>NULL</code>. </td></tr>
 506     <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_start</td><td>The beginning of the TAG directives list. </td></tr>
 507     <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_end</td><td>The end of the TAG directives list. </td></tr>
 508     <tr><td class="paramdir">[in]</td><td class="paramname">start_implicit</td><td>If the document start indicator is implicit. </td></tr>
 509     <tr><td class="paramdir">[in]</td><td class="paramname">end_implicit</td><td>If the document end indicator is implicit.</td></tr>
 510   </table>
 511   </dd>
 512 </dl>
 513 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 514
 515 </div>
 516 </div>
 517 <a id="ga2754b1544fb4e110e83fafbc708b0672"></a>
 518 <h2 class="memtitle"><span class="permalink"><a href="#ga2754b1544fb4e110e83fafbc708b0672">&#9670;&nbsp;</a></span>yaml_document_delete()</h2>
 519
 520 <div class="memitem">
 521 <div class="memproto">
 522       <table class="memname">
 523         <tr>
 524           <td class="memname">void yaml_document_delete </td>
 525           <td>(</td>
 526           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 527           <td class="paramname"><em>document</em></td><td>)</td>
 528           <td></td>
 529         </tr>
 530       </table>
 531 </div><div class="memdoc">
 532
 533 <p>Delete a YAML document and all its nodes. </p>
 534 <dl class="params"><dt>Parameters</dt><dd>
 535   <table class="params">
 536     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
 537   </table>
 538   </dd>
 539 </dl>
 540
 541 </div>
 542 </div>
 543 <a id="gafa1feabc9747dbded4dca24e27d3c21a"></a>
 544 <h2 class="memtitle"><span class="permalink"><a href="#gafa1feabc9747dbded4dca24e27d3c21a">&#9670;&nbsp;</a></span>yaml_document_get_node()</h2>
 545
 546 <div class="memitem">
 547 <div class="memproto">
 548       <table class="memname">
 549         <tr>
 550           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_get_node </td>
 551           <td>(</td>
 552           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 553           <td class="paramname"><em>document</em>, </td>
 554         </tr>
 555         <tr>
 556           <td class="paramkey"></td>
 557           <td></td>
 558           <td class="paramtype">int&#160;</td>
 559           <td class="paramname"><em>index</em>&#160;</td>
 560         </tr>
 561         <tr>
 562           <td></td>
 563           <td>)</td>
 564           <td></td><td></td>
 565         </tr>
 566       </table>
 567 </div><div class="memdoc">
 568
 569 <p>Get a node of a YAML document. </p>
 570 <p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p>
 571 <dl class="params"><dt>Parameters</dt><dd>
 572   <table class="params">
 573     <tr><td class="paramdir">[in]</td><td class="paramname">document</td><td>A document object. </td></tr>
 574     <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The node id.</td></tr>
 575   </table>
 576   </dd>
 577 </dl>
 578 <dl class="section return"><dt>Returns</dt><dd>the node objct or <code>NULL</code> if <code>node_id</code> is out of range. </dd></dl>
 579
 580 </div>
 581 </div>
 582 <a id="ga40eeaa68fb2f3be34c4fe34e7597d324"></a>
 583 <h2 class="memtitle"><span class="permalink"><a href="#ga40eeaa68fb2f3be34c4fe34e7597d324">&#9670;&nbsp;</a></span>yaml_document_get_root_node()</h2>
 584
 585 <div class="memitem">
 586 <div class="memproto">
 587       <table class="memname">
 588         <tr>
 589           <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_get_root_node </td>
 590           <td>(</td>
 591           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 592           <td class="paramname"><em>document</em></td><td>)</td>
 593           <td></td>
 594         </tr>
 595       </table>
 596 </div><div class="memdoc">
 597
 598 <p>Get the root of a YAML document node. </p>
 599 <p>The root object is the first object added to the document.</p>
 600 <p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p>
 601 <p>An empty document produced by the parser signifies the end of a YAML stream.</p>
 602 <dl class="params"><dt>Parameters</dt><dd>
 603   <table class="params">
 604     <tr><td class="paramdir">[in]</td><td class="paramname">document</td><td>A document object.</td></tr>
 605   </table>
 606   </dd>
 607 </dl>
 608 <dl class="section return"><dt>Returns</dt><dd>the node object or <code>NULL</code> if the document is empty. </dd></dl>
 609
 610 </div>
 611 </div>
 612 <a id="ga45dab8b983b58a005557d4b01f5057b0"></a>
 613 <h2 class="memtitle"><span class="permalink"><a href="#ga45dab8b983b58a005557d4b01f5057b0">&#9670;&nbsp;</a></span>yaml_document_add_scalar()</h2>
 614
 615 <div class="memitem">
 616 <div class="memproto">
 617       <table class="memname">
 618         <tr>
 619           <td class="memname">int yaml_document_add_scalar </td>
 620           <td>(</td>
 621           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 622           <td class="paramname"><em>document</em>, </td>
 623         </tr>
 624         <tr>
 625           <td class="paramkey"></td>
 626           <td></td>
 627           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 628           <td class="paramname"><em>tag</em>, </td>
 629         </tr>
 630         <tr>
 631           <td class="paramkey"></td>
 632           <td></td>
 633           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 634           <td class="paramname"><em>value</em>, </td>
 635         </tr>
 636         <tr>
 637           <td class="paramkey"></td>
 638           <td></td>
 639           <td class="paramtype">int&#160;</td>
 640           <td class="paramname"><em>length</em>, </td>
 641         </tr>
 642         <tr>
 643           <td class="paramkey"></td>
 644           <td></td>
 645           <td class="paramtype"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a>&#160;</td>
 646           <td class="paramname"><em>style</em>&#160;</td>
 647         </tr>
 648         <tr>
 649           <td></td>
 650           <td>)</td>
 651           <td></td><td></td>
 652         </tr>
 653       </table>
 654 </div><div class="memdoc">
 655
 656 <p>Create a SCALAR node and attach it to the document. </p>
 657 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 658 <dl class="params"><dt>Parameters</dt><dd>
 659   <table class="params">
 660     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
 661     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The scalar tag. </td></tr>
 662     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The scalar value. </td></tr>
 663     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the scalar value. </td></tr>
 664     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The scalar style.</td></tr>
 665   </table>
 666   </dd>
 667 </dl>
 668 <dl class="section return"><dt>Returns</dt><dd>the node id or <code>0</code> on error. </dd></dl>
 669
 670 </div>
 671 </div>
 672 <a id="ga83b2f7fdd9a439397a42016bddad7786"></a>
 673 <h2 class="memtitle"><span class="permalink"><a href="#ga83b2f7fdd9a439397a42016bddad7786">&#9670;&nbsp;</a></span>yaml_document_add_sequence()</h2>
 674
 675 <div class="memitem">
 676 <div class="memproto">
 677       <table class="memname">
 678         <tr>
 679           <td class="memname">int yaml_document_add_sequence </td>
 680           <td>(</td>
 681           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 682           <td class="paramname"><em>document</em>, </td>
 683         </tr>
 684         <tr>
 685           <td class="paramkey"></td>
 686           <td></td>
 687           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 688           <td class="paramname"><em>tag</em>, </td>
 689         </tr>
 690         <tr>
 691           <td class="paramkey"></td>
 692           <td></td>
 693           <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a>&#160;</td>
 694           <td class="paramname"><em>style</em>&#160;</td>
 695         </tr>
 696         <tr>
 697           <td></td>
 698           <td>)</td>
 699           <td></td><td></td>
 700         </tr>
 701       </table>
 702 </div><div class="memdoc">
 703
 704 <p>Create a SEQUENCE node and attach it to the document. </p>
 705 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 706 <dl class="params"><dt>Parameters</dt><dd>
 707   <table class="params">
 708     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
 709     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag. </td></tr>
 710     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr>
 711   </table>
 712   </dd>
 713 </dl>
 714 <dl class="section return"><dt>Returns</dt><dd>the node id or <code>0</code> on error. </dd></dl>
 715
 716 </div>
 717 </div>
 718 <a id="ga45a9f8288704f99cd81dc5cb31329d34"></a>
 719 <h2 class="memtitle"><span class="permalink"><a href="#ga45a9f8288704f99cd81dc5cb31329d34">&#9670;&nbsp;</a></span>yaml_document_add_mapping()</h2>
 720
 721 <div class="memitem">
 722 <div class="memproto">
 723       <table class="memname">
 724         <tr>
 725           <td class="memname">int yaml_document_add_mapping </td>
 726           <td>(</td>
 727           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 728           <td class="paramname"><em>document</em>, </td>
 729         </tr>
 730         <tr>
 731           <td class="paramkey"></td>
 732           <td></td>
 733           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 734           <td class="paramname"><em>tag</em>, </td>
 735         </tr>
 736         <tr>
 737           <td class="paramkey"></td>
 738           <td></td>
 739           <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a>&#160;</td>
 740           <td class="paramname"><em>style</em>&#160;</td>
 741         </tr>
 742         <tr>
 743           <td></td>
 744           <td>)</td>
 745           <td></td><td></td>
 746         </tr>
 747       </table>
 748 </div><div class="memdoc">
 749
 750 <p>Create a MAPPING node and attach it to the document. </p>
 751 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 752 <dl class="params"><dt>Parameters</dt><dd>
 753   <table class="params">
 754     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
 755     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag. </td></tr>
 756     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr>
 757   </table>
 758   </dd>
 759 </dl>
 760 <dl class="section return"><dt>Returns</dt><dd>the node id or <code>0</code> on error. </dd></dl>
 761
 762 </div>
 763 </div>
 764 <a id="ga16435917cd6c0261cd390fa8cf173b1b"></a>
 765 <h2 class="memtitle"><span class="permalink"><a href="#ga16435917cd6c0261cd390fa8cf173b1b">&#9670;&nbsp;</a></span>yaml_document_append_sequence_item()</h2>
 766
 767 <div class="memitem">
 768 <div class="memproto">
 769       <table class="memname">
 770         <tr>
 771           <td class="memname">int yaml_document_append_sequence_item </td>
 772           <td>(</td>
 773           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 774           <td class="paramname"><em>document</em>, </td>
 775         </tr>
 776         <tr>
 777           <td class="paramkey"></td>
 778           <td></td>
 779           <td class="paramtype">int&#160;</td>
 780           <td class="paramname"><em>sequence</em>, </td>
 781         </tr>
 782         <tr>
 783           <td class="paramkey"></td>
 784           <td></td>
 785           <td class="paramtype">int&#160;</td>
 786           <td class="paramname"><em>item</em>&#160;</td>
 787         </tr>
 788         <tr>
 789           <td></td>
 790           <td>)</td>
 791           <td></td><td></td>
 792         </tr>
 793       </table>
 794 </div><div class="memdoc">
 795
 796 <p>Add an item to a SEQUENCE node. </p>
 797 <dl class="params"><dt>Parameters</dt><dd>
 798   <table class="params">
 799     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
 800     <tr><td class="paramdir">[in]</td><td class="paramname">sequence</td><td>The sequence node id. </td></tr>
 801     <tr><td class="paramdir">[in]</td><td class="paramname">item</td><td>The item node id.</td></tr>
 802   </table>
 803   </dd>
 804 </dl>
 805 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 806
 807 </div>
 808 </div>
 809 <a id="ga2db27002d8a9ae06b1729d0ee06553d2"></a>
 810 <h2 class="memtitle"><span class="permalink"><a href="#ga2db27002d8a9ae06b1729d0ee06553d2">&#9670;&nbsp;</a></span>yaml_document_append_mapping_pair()</h2>
 811
 812 <div class="memitem">
 813 <div class="memproto">
 814       <table class="memname">
 815         <tr>
 816           <td class="memname">int yaml_document_append_mapping_pair </td>
 817           <td>(</td>
 818           <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *&#160;</td>
 819           <td class="paramname"><em>document</em>, </td>
 820         </tr>
 821         <tr>
 822           <td class="paramkey"></td>
 823           <td></td>
 824           <td class="paramtype">int&#160;</td>
 825           <td class="paramname"><em>mapping</em>, </td>
 826         </tr>
 827         <tr>
 828           <td class="paramkey"></td>
 829           <td></td>
 830           <td class="paramtype">int&#160;</td>
 831           <td class="paramname"><em>key</em>, </td>
 832         </tr>
 833         <tr>
 834           <td class="paramkey"></td>
 835           <td></td>
 836           <td class="paramtype">int&#160;</td>
 837           <td class="paramname"><em>value</em>&#160;</td>
 838         </tr>
 839         <tr>
 840           <td></td>
 841           <td>)</td>
 842           <td></td><td></td>
 843         </tr>
 844       </table>
 845 </div><div class="memdoc">
 846
 847 <p>Add a pair of a key and a value to a MAPPING node. </p>
 848 <dl class="params"><dt>Parameters</dt><dd>
 849   <table class="params">
 850     <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
 851     <tr><td class="paramdir">[in]</td><td class="paramname">mapping</td><td>The mapping node id. </td></tr>
 852     <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The key node id. </td></tr>
 853     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value node id.</td></tr>
 854   </table>
 855   </dd>
 856 </dl>
 857 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 858
 859 </div>
 860 </div>
 861 </div><!-- contents -->
 862 <!-- start footer part -->
 863 <hr class="footer"/><address class="footer"><small>
 864 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 865 <img class="footer" src="doxygen.png" alt="doxygen"/>
 866 </a> 1.8.14
 867 </small></address>
 868 </body>
 869 </html>