doc/html/group__nodes.html

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