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