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">
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
6 <meta name="generator" content="Doxygen 1.8.14"/>
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
8 <title>yaml: Nodes</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
17 <table cellspacing="0" cellpadding="0">
19 <tr style="height: 56px;">
20 <td id="projectalign" style="padding-left: 0.5em;">
21 <div id="projectname">yaml
22  <span id="projectnumber">0.2.2</span>
29 <!-- end header part -->
30 <!-- Generated by Doxygen 1.8.14 -->
31 <script type="text/javascript" src="menudata.js"></script>
32 <script type="text/javascript" src="menu.js"></script>
33 <script type="text/javascript">
34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
36 initMenu('',false,false,'search.php','Search');
38 /* @license-end */</script>
39 <div id="main-nav"></div>
43 <a href="#nested-classes">Data Structures</a> |
44 <a href="#define-members">Macros</a> |
45 <a href="#typedef-members">Typedefs</a> |
46 <a href="#enum-members">Enumerations</a> |
47 <a href="#func-members">Functions</a> </div>
48 <div class="headertitle">
49 <div class="title">Nodes</div> </div>
51 <div class="contents">
52 <table class="memberdecls">
53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
54 Data Structures</h2></td></tr>
55 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a></td></tr>
56 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">An element of a mapping node. <a href="structyaml__node__pair__s.html#details">More...</a><br /></td></tr>
57 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
58 <tr class="memitem:"><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>
59 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The node structure. <a href="structyaml__node__s.html#details">More...</a><br /></td></tr>
60 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
61 <tr class="memitem:"><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>
62 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The document structure. <a href="structyaml__document__s.html#details">More...</a><br /></td></tr>
63 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
64 </table><table class="memberdecls">
65 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
67 <tr class="memitem:gadfa882b6e42a3a993d12392d55260b00"><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>
68 <tr class="memdesc:gadfa882b6e42a3a993d12392d55260b00"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!null</code> with the only possible value: <code>null</code>. <a href="#gadfa882b6e42a3a993d12392d55260b00">More...</a><br /></td></tr>
69 <tr class="separator:gadfa882b6e42a3a993d12392d55260b00"><td class="memSeparator" colspan="2"> </td></tr>
70 <tr class="memitem:ga312629a1f51e91b136352db988d4d771"><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>
71 <tr class="memdesc:ga312629a1f51e91b136352db988d4d771"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!bool</code> with the values: <code>true</code> and <code>false</code>. <a href="#ga312629a1f51e91b136352db988d4d771">More...</a><br /></td></tr>
72 <tr class="separator:ga312629a1f51e91b136352db988d4d771"><td class="memSeparator" colspan="2"> </td></tr>
73 <tr class="memitem:gac5dbc6d1f556663edf8db88d6113e931"><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>
74 <tr class="memdesc:gac5dbc6d1f556663edf8db88d6113e931"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!str</code> for string values. <a href="#gac5dbc6d1f556663edf8db88d6113e931">More...</a><br /></td></tr>
75 <tr class="separator:gac5dbc6d1f556663edf8db88d6113e931"><td class="memSeparator" colspan="2"> </td></tr>
76 <tr class="memitem:ga83263cdb4ffa6ad2f7d9a87281979ff5"><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>
77 <tr class="memdesc:ga83263cdb4ffa6ad2f7d9a87281979ff5"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!int</code> for integer values. <a href="#ga83263cdb4ffa6ad2f7d9a87281979ff5">More...</a><br /></td></tr>
78 <tr class="separator:ga83263cdb4ffa6ad2f7d9a87281979ff5"><td class="memSeparator" colspan="2"> </td></tr>
79 <tr class="memitem:ga6ab2ec71fc47cb24f1003b9acdb92843"><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>
80 <tr class="memdesc:ga6ab2ec71fc47cb24f1003b9acdb92843"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!float</code> for float values. <a href="#ga6ab2ec71fc47cb24f1003b9acdb92843">More...</a><br /></td></tr>
81 <tr class="separator:ga6ab2ec71fc47cb24f1003b9acdb92843"><td class="memSeparator" colspan="2"> </td></tr>
82 <tr class="memitem:ga3e27cca7191234f2e8c95eaf3bc99a73"><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>
83 <tr class="memdesc:ga3e27cca7191234f2e8c95eaf3bc99a73"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!timestamp</code> for date and time values. <a href="#ga3e27cca7191234f2e8c95eaf3bc99a73">More...</a><br /></td></tr>
84 <tr class="separator:ga3e27cca7191234f2e8c95eaf3bc99a73"><td class="memSeparator" colspan="2"> </td></tr>
85 <tr class="memitem:gaa8284b30f9c9e3f10f6a69c9b882f417"><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>
86 <tr class="memdesc:gaa8284b30f9c9e3f10f6a69c9b882f417"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!seq</code> is used to denote sequences. <a href="#gaa8284b30f9c9e3f10f6a69c9b882f417">More...</a><br /></td></tr>
87 <tr class="separator:gaa8284b30f9c9e3f10f6a69c9b882f417"><td class="memSeparator" colspan="2"> </td></tr>
88 <tr class="memitem:ga22ae99cf3ac014dd76873268fd068c12"><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>
89 <tr class="memdesc:ga22ae99cf3ac014dd76873268fd068c12"><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!map</code> is used to denote mapping. <a href="#ga22ae99cf3ac014dd76873268fd068c12">More...</a><br /></td></tr>
90 <tr class="separator:ga22ae99cf3ac014dd76873268fd068c12"><td class="memSeparator" colspan="2"> </td></tr>
91 <tr class="memitem:gaf6b0c4e819b8f6915515a4f70065aaaa"><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>   <a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a></td></tr>
92 <tr class="memdesc:gaf6b0c4e819b8f6915515a4f70065aaaa"><td class="mdescLeft"> </td><td class="mdescRight">The default scalar tag is <code>!!str</code>. <a href="#gaf6b0c4e819b8f6915515a4f70065aaaa">More...</a><br /></td></tr>
93 <tr class="separator:gaf6b0c4e819b8f6915515a4f70065aaaa"><td class="memSeparator" colspan="2"> </td></tr>
94 <tr class="memitem:gaf195b67002518702e27746d6b4da6124"><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>   <a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a></td></tr>
95 <tr class="memdesc:gaf195b67002518702e27746d6b4da6124"><td class="mdescLeft"> </td><td class="mdescRight">The default sequence tag is <code>!!seq</code>. <a href="#gaf195b67002518702e27746d6b4da6124">More...</a><br /></td></tr>
96 <tr class="separator:gaf195b67002518702e27746d6b4da6124"><td class="memSeparator" colspan="2"> </td></tr>
97 <tr class="memitem:gaf7b1f8f0ce5665794510cd3841802a5f"><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>   <a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a></td></tr>
98 <tr class="memdesc:gaf7b1f8f0ce5665794510cd3841802a5f"><td class="mdescLeft"> </td><td class="mdescRight">The default mapping tag is <code>!!map</code>. <a href="#gaf7b1f8f0ce5665794510cd3841802a5f">More...</a><br /></td></tr>
99 <tr class="separator:gaf7b1f8f0ce5665794510cd3841802a5f"><td class="memSeparator" colspan="2"> </td></tr>
100 </table><table class="memberdecls">
101 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
102 Typedefs</h2></td></tr>
103 <tr class="memitem:gabe020d2fc42d3e896549e9f97da622d2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td></tr>
104 <tr class="memdesc:gabe020d2fc42d3e896549e9f97da622d2"><td class="mdescLeft"> </td><td class="mdescRight">Node types. <a href="#gabe020d2fc42d3e896549e9f97da622d2">More...</a><br /></td></tr>
105 <tr class="separator:gabe020d2fc42d3e896549e9f97da622d2"><td class="memSeparator" colspan="2"> </td></tr>
106 <tr class="memitem:ga9eaaa233b120b9d9db47de93c294c40f"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td></tr>
107 <tr class="memdesc:ga9eaaa233b120b9d9db47de93c294c40f"><td class="mdescLeft"> </td><td class="mdescRight">The forward definition of a document node structure. <a href="#ga9eaaa233b120b9d9db47de93c294c40f">More...</a><br /></td></tr>
108 <tr class="separator:ga9eaaa233b120b9d9db47de93c294c40f"><td class="memSeparator" colspan="2"> </td></tr>
109 <tr class="memitem:ga7cc3581582e778b00c04e99cd3656860"><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>
110 <tr class="memdesc:ga7cc3581582e778b00c04e99cd3656860"><td class="mdescLeft"> </td><td class="mdescRight">An element of a sequence node. <a href="#ga7cc3581582e778b00c04e99cd3656860">More...</a><br /></td></tr>
111 <tr class="separator:ga7cc3581582e778b00c04e99cd3656860"><td class="memSeparator" colspan="2"> </td></tr>
112 <tr class="memitem:ga90f1c8b83c5c38dc4016afc1cc2050c4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td></tr>
113 <tr class="memdesc:ga90f1c8b83c5c38dc4016afc1cc2050c4"><td class="mdescLeft"> </td><td class="mdescRight">An element of a mapping node. <a href="#ga90f1c8b83c5c38dc4016afc1cc2050c4">More...</a><br /></td></tr>
114 <tr class="separator:ga90f1c8b83c5c38dc4016afc1cc2050c4"><td class="memSeparator" colspan="2"> </td></tr>
115 <tr class="memitem:gad94e064e95baeb22e4f7acc7804e8479"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td></tr>
116 <tr class="memdesc:gad94e064e95baeb22e4f7acc7804e8479"><td class="mdescLeft"> </td><td class="mdescRight">The document structure. <a href="#gad94e064e95baeb22e4f7acc7804e8479">More...</a><br /></td></tr>
117 <tr class="separator:gad94e064e95baeb22e4f7acc7804e8479"><td class="memSeparator" colspan="2"> </td></tr>
118 </table><table class="memberdecls">
119 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
120 Enumerations</h2></td></tr>
121 <tr class="memitem:ga0897d4b6bdd1b56c7a5fa0ff17b4f798"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> { <br />
122   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739">YAML_NO_NODE</a>,
124   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45">YAML_SCALAR_NODE</a>,
126   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15">YAML_SEQUENCE_NODE</a>,
128   <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6">YAML_MAPPING_NODE</a>
131 <tr class="memdesc:ga0897d4b6bdd1b56c7a5fa0ff17b4f798"><td class="mdescLeft"> </td><td class="mdescRight">Node types. <a href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">More...</a><br /></td></tr>
132 <tr class="separator:ga0897d4b6bdd1b56c7a5fa0ff17b4f798"><td class="memSeparator" colspan="2"> </td></tr>
133 </table><table class="memberdecls">
134 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
135 Functions</h2></td></tr>
136 <tr class="memitem:ga62a485c96f3b7962436a0da5e6f3cc89"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89">yaml_document_initialize</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *version_directive, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_end, int start_implicit, int end_implicit)</td></tr>
137 <tr class="memdesc:ga62a485c96f3b7962436a0da5e6f3cc89"><td class="mdescLeft"> </td><td class="mdescRight">Create a YAML document. <a href="#ga62a485c96f3b7962436a0da5e6f3cc89">More...</a><br /></td></tr>
138 <tr class="separator:ga62a485c96f3b7962436a0da5e6f3cc89"><td class="memSeparator" colspan="2"> </td></tr>
139 <tr class="memitem:ga2754b1544fb4e110e83fafbc708b0672"><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="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
140 <tr class="memdesc:ga2754b1544fb4e110e83fafbc708b0672"><td class="mdescLeft"> </td><td class="mdescRight">Delete a YAML document and all its nodes. <a href="#ga2754b1544fb4e110e83fafbc708b0672">More...</a><br /></td></tr>
141 <tr class="separator:ga2754b1544fb4e110e83fafbc708b0672"><td class="memSeparator" colspan="2"> </td></tr>
142 <tr class="memitem:gafa1feabc9747dbded4dca24e27d3c21a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gafa1feabc9747dbded4dca24e27d3c21a">yaml_document_get_node</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int index)</td></tr>
143 <tr class="memdesc:gafa1feabc9747dbded4dca24e27d3c21a"><td class="mdescLeft"> </td><td class="mdescRight">Get a node of a YAML document. <a href="#gafa1feabc9747dbded4dca24e27d3c21a">More...</a><br /></td></tr>
144 <tr class="separator:gafa1feabc9747dbded4dca24e27d3c21a"><td class="memSeparator" colspan="2"> </td></tr>
145 <tr class="memitem:ga40eeaa68fb2f3be34c4fe34e7597d324"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga40eeaa68fb2f3be34c4fe34e7597d324">yaml_document_get_root_node</a> (<a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
146 <tr class="memdesc:ga40eeaa68fb2f3be34c4fe34e7597d324"><td class="mdescLeft"> </td><td class="mdescRight">Get the root of a YAML document node. <a href="#ga40eeaa68fb2f3be34c4fe34e7597d324">More...</a><br /></td></tr>
147 <tr class="separator:ga40eeaa68fb2f3be34c4fe34e7597d324"><td class="memSeparator" colspan="2"> </td></tr>
148 <tr class="memitem:ga45dab8b983b58a005557d4b01f5057b0"><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="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr>
149 <tr class="memdesc:ga45dab8b983b58a005557d4b01f5057b0"><td class="mdescLeft"> </td><td class="mdescRight">Create a SCALAR node and attach it to the document. <a href="#ga45dab8b983b58a005557d4b01f5057b0">More...</a><br /></td></tr>
150 <tr class="separator:ga45dab8b983b58a005557d4b01f5057b0"><td class="memSeparator" colspan="2"> </td></tr>
151 <tr class="memitem:ga83b2f7fdd9a439397a42016bddad7786"><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="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr>
152 <tr class="memdesc:ga83b2f7fdd9a439397a42016bddad7786"><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE node and attach it to the document. <a href="#ga83b2f7fdd9a439397a42016bddad7786">More...</a><br /></td></tr>
153 <tr class="separator:ga83b2f7fdd9a439397a42016bddad7786"><td class="memSeparator" colspan="2"> </td></tr>
154 <tr class="memitem:ga45a9f8288704f99cd81dc5cb31329d34"><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="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr>
155 <tr class="memdesc:ga45a9f8288704f99cd81dc5cb31329d34"><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING node and attach it to the document. <a href="#ga45a9f8288704f99cd81dc5cb31329d34">More...</a><br /></td></tr>
156 <tr class="separator:ga45a9f8288704f99cd81dc5cb31329d34"><td class="memSeparator" colspan="2"> </td></tr>
157 <tr class="memitem:ga16435917cd6c0261cd390fa8cf173b1b"><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="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int sequence, int item)</td></tr>
158 <tr class="memdesc:ga16435917cd6c0261cd390fa8cf173b1b"><td class="mdescLeft"> </td><td class="mdescRight">Add an item to a SEQUENCE node. <a href="#ga16435917cd6c0261cd390fa8cf173b1b">More...</a><br /></td></tr>
159 <tr class="separator:ga16435917cd6c0261cd390fa8cf173b1b"><td class="memSeparator" colspan="2"> </td></tr>
160 <tr class="memitem:ga2db27002d8a9ae06b1729d0ee06553d2"><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="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document, int mapping, int key, int value)</td></tr>
161 <tr class="memdesc:ga2db27002d8a9ae06b1729d0ee06553d2"><td class="mdescLeft"> </td><td class="mdescRight">Add a pair of a key and a value to a MAPPING node. <a href="#ga2db27002d8a9ae06b1729d0ee06553d2">More...</a><br /></td></tr>
162 <tr class="separator:ga2db27002d8a9ae06b1729d0ee06553d2"><td class="memSeparator" colspan="2"> </td></tr>
164 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
165 <h2 class="groupheader">Macro Definition Documentation</h2>
166 <a id="gadfa882b6e42a3a993d12392d55260b00"></a>
167 <h2 class="memtitle"><span class="permalink"><a href="#gadfa882b6e42a3a993d12392d55260b00">◆ </a></span>YAML_NULL_TAG</h2>
169 <div class="memitem">
170 <div class="memproto">
171 <table class="memname">
173 <td class="memname">#define YAML_NULL_TAG   "tag:yaml.org,2002:null"</td>
176 </div><div class="memdoc">
178 <p>The tag <code>!!null</code> with the only possible value: <code>null</code>. </p>
182 <a id="ga312629a1f51e91b136352db988d4d771"></a>
183 <h2 class="memtitle"><span class="permalink"><a href="#ga312629a1f51e91b136352db988d4d771">◆ </a></span>YAML_BOOL_TAG</h2>
185 <div class="memitem">
186 <div class="memproto">
187 <table class="memname">
189 <td class="memname">#define YAML_BOOL_TAG   "tag:yaml.org,2002:bool"</td>
192 </div><div class="memdoc">
194 <p>The tag <code>!!bool</code> with the values: <code>true</code> and <code>false</code>. </p>
198 <a id="gac5dbc6d1f556663edf8db88d6113e931"></a>
199 <h2 class="memtitle"><span class="permalink"><a href="#gac5dbc6d1f556663edf8db88d6113e931">◆ </a></span>YAML_STR_TAG</h2>
201 <div class="memitem">
202 <div class="memproto">
203 <table class="memname">
205 <td class="memname">#define YAML_STR_TAG   "tag:yaml.org,2002:str"</td>
208 </div><div class="memdoc">
210 <p>The tag <code>!!str</code> for string values. </p>
214 <a id="ga83263cdb4ffa6ad2f7d9a87281979ff5"></a>
215 <h2 class="memtitle"><span class="permalink"><a href="#ga83263cdb4ffa6ad2f7d9a87281979ff5">◆ </a></span>YAML_INT_TAG</h2>
217 <div class="memitem">
218 <div class="memproto">
219 <table class="memname">
221 <td class="memname">#define YAML_INT_TAG   "tag:yaml.org,2002:int"</td>
224 </div><div class="memdoc">
226 <p>The tag <code>!!int</code> for integer values. </p>
230 <a id="ga6ab2ec71fc47cb24f1003b9acdb92843"></a>
231 <h2 class="memtitle"><span class="permalink"><a href="#ga6ab2ec71fc47cb24f1003b9acdb92843">◆ </a></span>YAML_FLOAT_TAG</h2>
233 <div class="memitem">
234 <div class="memproto">
235 <table class="memname">
237 <td class="memname">#define YAML_FLOAT_TAG   "tag:yaml.org,2002:float"</td>
240 </div><div class="memdoc">
242 <p>The tag <code>!!float</code> for float values. </p>
246 <a id="ga3e27cca7191234f2e8c95eaf3bc99a73"></a>
247 <h2 class="memtitle"><span class="permalink"><a href="#ga3e27cca7191234f2e8c95eaf3bc99a73">◆ </a></span>YAML_TIMESTAMP_TAG</h2>
249 <div class="memitem">
250 <div class="memproto">
251 <table class="memname">
253 <td class="memname">#define YAML_TIMESTAMP_TAG   "tag:yaml.org,2002:timestamp"</td>
256 </div><div class="memdoc">
258 <p>The tag <code>!!timestamp</code> for date and time values. </p>
262 <a id="gaa8284b30f9c9e3f10f6a69c9b882f417"></a>
263 <h2 class="memtitle"><span class="permalink"><a href="#gaa8284b30f9c9e3f10f6a69c9b882f417">◆ </a></span>YAML_SEQ_TAG</h2>
265 <div class="memitem">
266 <div class="memproto">
267 <table class="memname">
269 <td class="memname">#define YAML_SEQ_TAG   "tag:yaml.org,2002:seq"</td>
272 </div><div class="memdoc">
274 <p>The tag <code>!!seq</code> is used to denote sequences. </p>
278 <a id="ga22ae99cf3ac014dd76873268fd068c12"></a>
279 <h2 class="memtitle"><span class="permalink"><a href="#ga22ae99cf3ac014dd76873268fd068c12">◆ </a></span>YAML_MAP_TAG</h2>
281 <div class="memitem">
282 <div class="memproto">
283 <table class="memname">
285 <td class="memname">#define YAML_MAP_TAG   "tag:yaml.org,2002:map"</td>
288 </div><div class="memdoc">
290 <p>The tag <code>!!map</code> is used to denote mapping. </p>
294 <a id="gaf6b0c4e819b8f6915515a4f70065aaaa"></a>
295 <h2 class="memtitle"><span class="permalink"><a href="#gaf6b0c4e819b8f6915515a4f70065aaaa">◆ </a></span>YAML_DEFAULT_SCALAR_TAG</h2>
297 <div class="memitem">
298 <div class="memproto">
299 <table class="memname">
301 <td class="memname">#define YAML_DEFAULT_SCALAR_TAG   <a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a></td>
304 </div><div class="memdoc">
306 <p>The default scalar tag is <code>!!str</code>. </p>
310 <a id="gaf195b67002518702e27746d6b4da6124"></a>
311 <h2 class="memtitle"><span class="permalink"><a href="#gaf195b67002518702e27746d6b4da6124">◆ </a></span>YAML_DEFAULT_SEQUENCE_TAG</h2>
313 <div class="memitem">
314 <div class="memproto">
315 <table class="memname">
317 <td class="memname">#define YAML_DEFAULT_SEQUENCE_TAG   <a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a></td>
320 </div><div class="memdoc">
322 <p>The default sequence tag is <code>!!seq</code>. </p>
326 <a id="gaf7b1f8f0ce5665794510cd3841802a5f"></a>
327 <h2 class="memtitle"><span class="permalink"><a href="#gaf7b1f8f0ce5665794510cd3841802a5f">◆ </a></span>YAML_DEFAULT_MAPPING_TAG</h2>
329 <div class="memitem">
330 <div class="memproto">
331 <table class="memname">
333 <td class="memname">#define YAML_DEFAULT_MAPPING_TAG   <a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a></td>
336 </div><div class="memdoc">
338 <p>The default mapping tag is <code>!!map</code>. </p>
342 <h2 class="groupheader">Typedef Documentation</h2>
343 <a id="gabe020d2fc42d3e896549e9f97da622d2"></a>
344 <h2 class="memtitle"><span class="permalink"><a href="#gabe020d2fc42d3e896549e9f97da622d2">◆ </a></span>yaml_node_type_t</h2>
346 <div class="memitem">
347 <div class="memproto">
348 <table class="memname">
350 <td class="memname">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> <a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td>
353 </div><div class="memdoc">
359 <a id="ga9eaaa233b120b9d9db47de93c294c40f"></a>
360 <h2 class="memtitle"><span class="permalink"><a href="#ga9eaaa233b120b9d9db47de93c294c40f">◆ </a></span>yaml_node_t</h2>
362 <div class="memitem">
363 <div class="memproto">
364 <table class="memname">
366 <td class="memname">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> <a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td>
369 </div><div class="memdoc">
371 <p>The forward definition of a document node structure. </p>
375 <a id="ga7cc3581582e778b00c04e99cd3656860"></a>
376 <h2 class="memtitle"><span class="permalink"><a href="#ga7cc3581582e778b00c04e99cd3656860">◆ </a></span>yaml_node_item_t</h2>
378 <div class="memitem">
379 <div class="memproto">
380 <table class="memname">
382 <td class="memname">typedef int <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td>
385 </div><div class="memdoc">
387 <p>An element of a sequence node. </p>
391 <a id="ga90f1c8b83c5c38dc4016afc1cc2050c4"></a>
392 <h2 class="memtitle"><span class="permalink"><a href="#ga90f1c8b83c5c38dc4016afc1cc2050c4">◆ </a></span>yaml_node_pair_t</h2>
394 <div class="memitem">
395 <div class="memproto">
396 <table class="memname">
398 <td class="memname">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a> <a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td>
401 </div><div class="memdoc">
403 <p>An element of a mapping node. </p>
407 <a id="gad94e064e95baeb22e4f7acc7804e8479"></a>
408 <h2 class="memtitle"><span class="permalink"><a href="#gad94e064e95baeb22e4f7acc7804e8479">◆ </a></span>yaml_document_t</h2>
410 <div class="memitem">
411 <div class="memproto">
412 <table class="memname">
414 <td class="memname">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a> <a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td>
417 </div><div class="memdoc">
419 <p>The document structure. </p>
423 <h2 class="groupheader">Enumeration Type Documentation</h2>
424 <a id="ga0897d4b6bdd1b56c7a5fa0ff17b4f798"></a>
425 <h2 class="memtitle"><span class="permalink"><a href="#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">◆ </a></span>yaml_node_type_e</h2>
427 <div class="memitem">
428 <div class="memproto">
429 <table class="memname">
431 <td class="memname">enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a></td>
434 </div><div class="memdoc">
437 <table class="fieldtable">
438 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739"></a>YAML_NO_NODE </td><td class="fielddoc"><p>An empty node. </p>
440 <tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45"></a>YAML_SCALAR_NODE </td><td class="fielddoc"><p>A scalar node. </p>
442 <tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15"></a>YAML_SEQUENCE_NODE </td><td class="fielddoc"><p>A sequence node. </p>
444 <tr><td class="fieldname"><a id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6"></a>YAML_MAPPING_NODE </td><td class="fielddoc"><p>A mapping node. </p>
450 <h2 class="groupheader">Function Documentation</h2>
451 <a id="ga62a485c96f3b7962436a0da5e6f3cc89"></a>
452 <h2 class="memtitle"><span class="permalink"><a href="#ga62a485c96f3b7962436a0da5e6f3cc89">◆ </a></span>yaml_document_initialize()</h2>
454 <div class="memitem">
455 <div class="memproto">
456 <table class="memname">
458 <td class="memname">int yaml_document_initialize </td>
460 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
461 <td class="paramname"><em>document</em>, </td>
464 <td class="paramkey"></td>
466 <td class="paramtype"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> * </td>
467 <td class="paramname"><em>version_directive</em>, </td>
470 <td class="paramkey"></td>
472 <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> * </td>
473 <td class="paramname"><em>tag_directives_start</em>, </td>
476 <td class="paramkey"></td>
478 <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> * </td>
479 <td class="paramname"><em>tag_directives_end</em>, </td>
482 <td class="paramkey"></td>
484 <td class="paramtype">int </td>
485 <td class="paramname"><em>start_implicit</em>, </td>
488 <td class="paramkey"></td>
490 <td class="paramtype">int </td>
491 <td class="paramname"><em>end_implicit</em> </td>
499 </div><div class="memdoc">
501 <p>Create a YAML document. </p>
502 <dl class="params"><dt>Parameters</dt><dd>
503 <table class="params">
504 <tr><td class="paramdir">[out]</td><td class="paramname">document</td><td>An empty document object. </td></tr>
505 <tr><td class="paramdir">[in]</td><td class="paramname">version_directive</td><td>The YAML directive value or <code>NULL</code>. </td></tr>
506 <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_start</td><td>The beginning of the TAG directives list. </td></tr>
507 <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_end</td><td>The end of the TAG directives list. </td></tr>
508 <tr><td class="paramdir">[in]</td><td class="paramname">start_implicit</td><td>If the document start indicator is implicit. </td></tr>
509 <tr><td class="paramdir">[in]</td><td class="paramname">end_implicit</td><td>If the document end indicator is implicit.</td></tr>
513 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
517 <a id="ga2754b1544fb4e110e83fafbc708b0672"></a>
518 <h2 class="memtitle"><span class="permalink"><a href="#ga2754b1544fb4e110e83fafbc708b0672">◆ </a></span>yaml_document_delete()</h2>
520 <div class="memitem">
521 <div class="memproto">
522 <table class="memname">
524 <td class="memname">void yaml_document_delete </td>
526 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
527 <td class="paramname"><em>document</em></td><td>)</td>
531 </div><div class="memdoc">
533 <p>Delete a YAML document and all its nodes. </p>
534 <dl class="params"><dt>Parameters</dt><dd>
535 <table class="params">
536 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
543 <a id="gafa1feabc9747dbded4dca24e27d3c21a"></a>
544 <h2 class="memtitle"><span class="permalink"><a href="#gafa1feabc9747dbded4dca24e27d3c21a">◆ </a></span>yaml_document_get_node()</h2>
546 <div class="memitem">
547 <div class="memproto">
548 <table class="memname">
550 <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_get_node </td>
552 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
553 <td class="paramname"><em>document</em>, </td>
556 <td class="paramkey"></td>
558 <td class="paramtype">int </td>
559 <td class="paramname"><em>index</em> </td>
567 </div><div class="memdoc">
569 <p>Get a node of a YAML document. </p>
570 <p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p>
571 <dl class="params"><dt>Parameters</dt><dd>
572 <table class="params">
573 <tr><td class="paramdir">[in]</td><td class="paramname">document</td><td>A document object. </td></tr>
574 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>The node id.</td></tr>
578 <dl class="section return"><dt>Returns</dt><dd>the node objct or <code>NULL</code> if <code>node_id</code> is out of range. </dd></dl>
582 <a id="ga40eeaa68fb2f3be34c4fe34e7597d324"></a>
583 <h2 class="memtitle"><span class="permalink"><a href="#ga40eeaa68fb2f3be34c4fe34e7597d324">◆ </a></span>yaml_document_get_root_node()</h2>
585 <div class="memitem">
586 <div class="memproto">
587 <table class="memname">
589 <td class="memname"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a>* yaml_document_get_root_node </td>
591 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
592 <td class="paramname"><em>document</em></td><td>)</td>
596 </div><div class="memdoc">
598 <p>Get the root of a YAML document node. </p>
599 <p>The root object is the first object added to the document.</p>
600 <p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p>
601 <p>An empty document produced by the parser signifies the end of a YAML stream.</p>
602 <dl class="params"><dt>Parameters</dt><dd>
603 <table class="params">
604 <tr><td class="paramdir">[in]</td><td class="paramname">document</td><td>A document object.</td></tr>
608 <dl class="section return"><dt>Returns</dt><dd>the node object or <code>NULL</code> if the document is empty. </dd></dl>
612 <a id="ga45dab8b983b58a005557d4b01f5057b0"></a>
613 <h2 class="memtitle"><span class="permalink"><a href="#ga45dab8b983b58a005557d4b01f5057b0">◆ </a></span>yaml_document_add_scalar()</h2>
615 <div class="memitem">
616 <div class="memproto">
617 <table class="memname">
619 <td class="memname">int yaml_document_add_scalar </td>
621 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
622 <td class="paramname"><em>document</em>, </td>
625 <td class="paramkey"></td>
627 <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td>
628 <td class="paramname"><em>tag</em>, </td>
631 <td class="paramkey"></td>
633 <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td>
634 <td class="paramname"><em>value</em>, </td>
637 <td class="paramkey"></td>
639 <td class="paramtype">int </td>
640 <td class="paramname"><em>length</em>, </td>
643 <td class="paramkey"></td>
645 <td class="paramtype"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> </td>
646 <td class="paramname"><em>style</em> </td>
654 </div><div class="memdoc">
656 <p>Create a SCALAR node and attach it to the document. </p>
657 <p>The <em>style</em> argument may be ignored by the emitter.</p>
658 <dl class="params"><dt>Parameters</dt><dd>
659 <table class="params">
660 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
661 <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The scalar tag. </td></tr>
662 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The scalar value. </td></tr>
663 <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the scalar value. </td></tr>
664 <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The scalar style.</td></tr>
668 <dl class="section return"><dt>Returns</dt><dd>the node id or <code>0</code> on error. </dd></dl>
672 <a id="ga83b2f7fdd9a439397a42016bddad7786"></a>
673 <h2 class="memtitle"><span class="permalink"><a href="#ga83b2f7fdd9a439397a42016bddad7786">◆ </a></span>yaml_document_add_sequence()</h2>
675 <div class="memitem">
676 <div class="memproto">
677 <table class="memname">
679 <td class="memname">int yaml_document_add_sequence </td>
681 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
682 <td class="paramname"><em>document</em>, </td>
685 <td class="paramkey"></td>
687 <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td>
688 <td class="paramname"><em>tag</em>, </td>
691 <td class="paramkey"></td>
693 <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> </td>
694 <td class="paramname"><em>style</em> </td>
702 </div><div class="memdoc">
704 <p>Create a SEQUENCE node and attach it to the document. </p>
705 <p>The <em>style</em> argument may be ignored by the emitter.</p>
706 <dl class="params"><dt>Parameters</dt><dd>
707 <table class="params">
708 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
709 <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag. </td></tr>
710 <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr>
714 <dl class="section return"><dt>Returns</dt><dd>the node id or <code>0</code> on error. </dd></dl>
718 <a id="ga45a9f8288704f99cd81dc5cb31329d34"></a>
719 <h2 class="memtitle"><span class="permalink"><a href="#ga45a9f8288704f99cd81dc5cb31329d34">◆ </a></span>yaml_document_add_mapping()</h2>
721 <div class="memitem">
722 <div class="memproto">
723 <table class="memname">
725 <td class="memname">int yaml_document_add_mapping </td>
727 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
728 <td class="paramname"><em>document</em>, </td>
731 <td class="paramkey"></td>
733 <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td>
734 <td class="paramname"><em>tag</em>, </td>
737 <td class="paramkey"></td>
739 <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> </td>
740 <td class="paramname"><em>style</em> </td>
748 </div><div class="memdoc">
750 <p>Create a MAPPING node and attach it to the document. </p>
751 <p>The <em>style</em> argument may be ignored by the emitter.</p>
752 <dl class="params"><dt>Parameters</dt><dd>
753 <table class="params">
754 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
755 <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag. </td></tr>
756 <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr>
760 <dl class="section return"><dt>Returns</dt><dd>the node id or <code>0</code> on error. </dd></dl>
764 <a id="ga16435917cd6c0261cd390fa8cf173b1b"></a>
765 <h2 class="memtitle"><span class="permalink"><a href="#ga16435917cd6c0261cd390fa8cf173b1b">◆ </a></span>yaml_document_append_sequence_item()</h2>
767 <div class="memitem">
768 <div class="memproto">
769 <table class="memname">
771 <td class="memname">int yaml_document_append_sequence_item </td>
773 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
774 <td class="paramname"><em>document</em>, </td>
777 <td class="paramkey"></td>
779 <td class="paramtype">int </td>
780 <td class="paramname"><em>sequence</em>, </td>
783 <td class="paramkey"></td>
785 <td class="paramtype">int </td>
786 <td class="paramname"><em>item</em> </td>
794 </div><div class="memdoc">
796 <p>Add an item to a SEQUENCE node. </p>
797 <dl class="params"><dt>Parameters</dt><dd>
798 <table class="params">
799 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
800 <tr><td class="paramdir">[in]</td><td class="paramname">sequence</td><td>The sequence node id. </td></tr>
801 <tr><td class="paramdir">[in]</td><td class="paramname">item</td><td>The item node id.</td></tr>
805 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
809 <a id="ga2db27002d8a9ae06b1729d0ee06553d2"></a>
810 <h2 class="memtitle"><span class="permalink"><a href="#ga2db27002d8a9ae06b1729d0ee06553d2">◆ </a></span>yaml_document_append_mapping_pair()</h2>
812 <div class="memitem">
813 <div class="memproto">
814 <table class="memname">
816 <td class="memname">int yaml_document_append_mapping_pair </td>
818 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
819 <td class="paramname"><em>document</em>, </td>
822 <td class="paramkey"></td>
824 <td class="paramtype">int </td>
825 <td class="paramname"><em>mapping</em>, </td>
828 <td class="paramkey"></td>
830 <td class="paramtype">int </td>
831 <td class="paramname"><em>key</em>, </td>
834 <td class="paramkey"></td>
836 <td class="paramtype">int </td>
837 <td class="paramname"><em>value</em> </td>
845 </div><div class="memdoc">
847 <p>Add a pair of a key and a value to a MAPPING node. </p>
848 <dl class="params"><dt>Parameters</dt><dd>
849 <table class="params">
850 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object. </td></tr>
851 <tr><td class="paramdir">[in]</td><td class="paramname">mapping</td><td>The mapping node id. </td></tr>
852 <tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The key node id. </td></tr>
853 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value node id.</td></tr>
857 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
861 </div><!-- contents -->
862 <!-- start footer part -->
863 <hr class="footer"/><address class="footer"><small>
864 Generated by  <a href="http://www.doxygen.org/index.html">
865 <img class="footer" src="doxygen.png" alt="doxygen"/>