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