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.6"/>
7 <title>yaml: Emitter Definitions</title>
8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
9 <script type="text/javascript" src="jquery.js"></script>
10 <script type="text/javascript" src="dynsections.js"></script>
11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
14 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
16 <table cellspacing="0" cellpadding="0">
18 <tr style="height: 56px;">
19 <td style="padding-left: 0.5em;">
20 <div id="projectname">yaml
21  <span id="projectnumber">0.1.7</span>
28 <!-- end header part -->
29 <!-- Generated by Doxygen 1.8.6 -->
30 <div id="navrow1" class="tabs">
32 <li><a href="index.html"><span>Main Page</span></a></li>
33 <li><a href="modules.html"><span>Modules</span></a></li>
34 <li><a href="annotated.html"><span>Data Structures</span></a></li>
35 <li><a href="files.html"><span>Files</span></a></li>
41 <a href="#nested-classes">Data Structures</a> |
42 <a href="#typedef-members">Typedefs</a> |
43 <a href="#enum-members">Enumerations</a> |
44 <a href="#func-members">Functions</a> </div>
45 <div class="headertitle">
46 <div class="title">Emitter Definitions</div> </div>
48 <div class="contents">
49 <table class="memberdecls">
50 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
51 Data Structures</h2></td></tr>
52 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a></td></tr>
53 <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="structyaml__emitter__s.html#details">More...</a><br/></td></tr>
54 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
55 </table><table class="memberdecls">
56 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
57 Typedefs</h2></td></tr>
58 <tr class="memitem:ga1669659aacbe631ad406c78fce1f5379"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> (void *data, unsigned char *buffer, size_t size)</td></tr>
59 <tr class="memdesc:ga1669659aacbe631ad406c78fce1f5379"><td class="mdescLeft"> </td><td class="mdescRight">The prototype of a write handler. <a href="#ga1669659aacbe631ad406c78fce1f5379">More...</a><br/></td></tr>
60 <tr class="separator:ga1669659aacbe631ad406c78fce1f5379"><td class="memSeparator" colspan="2"> </td></tr>
61 <tr class="memitem:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td></tr>
62 <tr class="memdesc:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="mdescLeft"> </td><td class="mdescRight">The emitter states. <a href="#ga0889461fa3efe8eee881aef48a4ba6b2">More...</a><br/></td></tr>
63 <tr class="separator:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memSeparator" colspan="2"> </td></tr>
64 <tr class="memitem:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td></tr>
65 <tr class="memdesc:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="#ga4ce3e054f0016c49d9e8c36d359e710b">More...</a><br/></td></tr>
66 <tr class="separator:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memSeparator" colspan="2"> </td></tr>
67 </table><table class="memberdecls">
68 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
69 Enumerations</h2></td></tr>
70 <tr class="memitem:ga387b79da11c3941e43a56947263aa721"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> { <br/>
71   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d">YAML_EMIT_STREAM_START_STATE</a>,
73   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae">YAML_EMIT_FIRST_DOCUMENT_START_STATE</a>,
75   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f">YAML_EMIT_DOCUMENT_START_STATE</a>,
77   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec">YAML_EMIT_DOCUMENT_CONTENT_STATE</a>,
79   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3">YAML_EMIT_DOCUMENT_END_STATE</a>,
81   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654">YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</a>,
83   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767">YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</a>,
85   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894">YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</a>,
87   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626">YAML_EMIT_FLOW_MAPPING_KEY_STATE</a>,
89   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383">YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</a>,
91   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e">YAML_EMIT_FLOW_MAPPING_VALUE_STATE</a>,
93   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d">YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</a>,
95   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff">YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</a>,
97   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e">YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</a>,
99   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05">YAML_EMIT_BLOCK_MAPPING_KEY_STATE</a>,
101   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704">YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</a>,
103   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564">YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</a>,
105   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0">YAML_EMIT_END_STATE</a>
108 <tr class="memdesc:ga387b79da11c3941e43a56947263aa721"><td class="mdescLeft"> </td><td class="mdescRight">The emitter states. <a href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">More...</a><br/></td></tr>
109 <tr class="separator:ga387b79da11c3941e43a56947263aa721"><td class="memSeparator" colspan="2"> </td></tr>
110 </table><table class="memberdecls">
111 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
112 Functions</h2></td></tr>
113 <tr class="memitem:ga83649205374285802fc27aa293ecd111"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga83649205374285802fc27aa293ecd111">yaml_emitter_initialize</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
114 <tr class="memdesc:ga83649205374285802fc27aa293ecd111"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an emitter. <a href="#ga83649205374285802fc27aa293ecd111">More...</a><br/></td></tr>
115 <tr class="separator:ga83649205374285802fc27aa293ecd111"><td class="memSeparator" colspan="2"> </td></tr>
116 <tr class="memitem:gad705212f3a5150e3f00075fd90bc8c3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gad705212f3a5150e3f00075fd90bc8c3d">yaml_emitter_delete</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
117 <tr class="memdesc:gad705212f3a5150e3f00075fd90bc8c3d"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an emitter. <a href="#gad705212f3a5150e3f00075fd90bc8c3d">More...</a><br/></td></tr>
118 <tr class="separator:gad705212f3a5150e3f00075fd90bc8c3d"><td class="memSeparator" colspan="2"> </td></tr>
119 <tr class="memitem:ga62725c0f616f634588374d1a4c0ed35a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga62725c0f616f634588374d1a4c0ed35a">yaml_emitter_set_output_string</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, unsigned char *output, size_t size, size_t *size_written)</td></tr>
120 <tr class="memdesc:ga62725c0f616f634588374d1a4c0ed35a"><td class="mdescLeft"> </td><td class="mdescRight">Set a string output. <a href="#ga62725c0f616f634588374d1a4c0ed35a">More...</a><br/></td></tr>
121 <tr class="separator:ga62725c0f616f634588374d1a4c0ed35a"><td class="memSeparator" colspan="2"> </td></tr>
122 <tr class="memitem:gaf7610c61b303bde9c701024c10ece024"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaf7610c61b303bde9c701024c10ece024">yaml_emitter_set_output_file</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, FILE *file)</td></tr>
123 <tr class="memdesc:gaf7610c61b303bde9c701024c10ece024"><td class="mdescLeft"> </td><td class="mdescRight">Set a file output. <a href="#gaf7610c61b303bde9c701024c10ece024">More...</a><br/></td></tr>
124 <tr class="separator:gaf7610c61b303bde9c701024c10ece024"><td class="memSeparator" colspan="2"> </td></tr>
125 <tr class="memitem:gac85a6a212ed7b469fb426a3451d15922"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gac85a6a212ed7b469fb426a3451d15922">yaml_emitter_set_output</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> *handler, void *data)</td></tr>
126 <tr class="memdesc:gac85a6a212ed7b469fb426a3451d15922"><td class="mdescLeft"> </td><td class="mdescRight">Set a generic output handler. <a href="#gac85a6a212ed7b469fb426a3451d15922">More...</a><br/></td></tr>
127 <tr class="separator:gac85a6a212ed7b469fb426a3451d15922"><td class="memSeparator" colspan="2"> </td></tr>
128 <tr class="memitem:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gabc22888ec8bf942199acbf38f7a0b9bb">yaml_emitter_set_encoding</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr>
129 <tr class="memdesc:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="mdescLeft"> </td><td class="mdescRight">Set the output encoding. <a href="#gabc22888ec8bf942199acbf38f7a0b9bb">More...</a><br/></td></tr>
130 <tr class="separator:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="memSeparator" colspan="2"> </td></tr>
131 <tr class="memitem:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga62713a8130e11d95cbefa95a2eb3ac4b">yaml_emitter_set_canonical</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int canonical)</td></tr>
132 <tr class="memdesc:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="mdescLeft"> </td><td class="mdescRight">Set if the output should be in the "canonical" format as in the YAML specification. <a href="#ga62713a8130e11d95cbefa95a2eb3ac4b">More...</a><br/></td></tr>
133 <tr class="separator:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="memSeparator" colspan="2"> </td></tr>
134 <tr class="memitem:ga07eca3c344053a9028b4a84291cdf4d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga07eca3c344053a9028b4a84291cdf4d7">yaml_emitter_set_indent</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int indent)</td></tr>
135 <tr class="memdesc:ga07eca3c344053a9028b4a84291cdf4d7"><td class="mdescLeft"> </td><td class="mdescRight">Set the intendation increment. <a href="#ga07eca3c344053a9028b4a84291cdf4d7">More...</a><br/></td></tr>
136 <tr class="separator:ga07eca3c344053a9028b4a84291cdf4d7"><td class="memSeparator" colspan="2"> </td></tr>
137 <tr class="memitem:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaa91ae0fa8af5ab67e64567e08f4458c2">yaml_emitter_set_width</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int width)</td></tr>
138 <tr class="memdesc:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line width. <a href="#gaa91ae0fa8af5ab67e64567e08f4458c2">More...</a><br/></td></tr>
139 <tr class="separator:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="memSeparator" colspan="2"> </td></tr>
140 <tr class="memitem:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaa59e7dcf24cb9b614c32af6c3e949fc3">yaml_emitter_set_unicode</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, int unicode)</td></tr>
141 <tr class="memdesc:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="mdescLeft"> </td><td class="mdescRight">Set if unescaped non-ASCII characters are allowed. <a href="#gaa59e7dcf24cb9b614c32af6c3e949fc3">More...</a><br/></td></tr>
142 <tr class="separator:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="memSeparator" colspan="2"> </td></tr>
143 <tr class="memitem:ga04b5494f0b8244eec359579c31d5e20c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga04b5494f0b8244eec359579c31d5e20c">yaml_emitter_set_break</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> line_break)</td></tr>
144 <tr class="memdesc:ga04b5494f0b8244eec359579c31d5e20c"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line break. <a href="#ga04b5494f0b8244eec359579c31d5e20c">More...</a><br/></td></tr>
145 <tr class="separator:ga04b5494f0b8244eec359579c31d5e20c"><td class="memSeparator" colspan="2"> </td></tr>
146 <tr class="memitem:ga4d6c0f8e712797e2660e69479fdae433"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga4d6c0f8e712797e2660e69479fdae433">yaml_emitter_emit</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
147 <tr class="memdesc:ga4d6c0f8e712797e2660e69479fdae433"><td class="mdescLeft"> </td><td class="mdescRight">Emit an event. <a href="#ga4d6c0f8e712797e2660e69479fdae433">More...</a><br/></td></tr>
148 <tr class="separator:ga4d6c0f8e712797e2660e69479fdae433"><td class="memSeparator" colspan="2"> </td></tr>
149 <tr class="memitem:gae323c34e378040106f24c7b5ab834b16"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gae323c34e378040106f24c7b5ab834b16">yaml_emitter_open</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
150 <tr class="memdesc:gae323c34e378040106f24c7b5ab834b16"><td class="mdescLeft"> </td><td class="mdescRight">Start a YAML stream. <a href="#gae323c34e378040106f24c7b5ab834b16">More...</a><br/></td></tr>
151 <tr class="separator:gae323c34e378040106f24c7b5ab834b16"><td class="memSeparator" colspan="2"> </td></tr>
152 <tr class="memitem:gaa91442864679280985df14b2d96b8c42"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gaa91442864679280985df14b2d96b8c42">yaml_emitter_close</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
153 <tr class="memdesc:gaa91442864679280985df14b2d96b8c42"><td class="mdescLeft"> </td><td class="mdescRight">Finish a YAML stream. <a href="#gaa91442864679280985df14b2d96b8c42">More...</a><br/></td></tr>
154 <tr class="separator:gaa91442864679280985df14b2d96b8c42"><td class="memSeparator" colspan="2"> </td></tr>
155 <tr class="memitem:ga5f0306abe9bff373b5bc339913b3769c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#ga5f0306abe9bff373b5bc339913b3769c">yaml_emitter_dump</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter, <a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> *document)</td></tr>
156 <tr class="memdesc:ga5f0306abe9bff373b5bc339913b3769c"><td class="mdescLeft"> </td><td class="mdescRight">Emit a YAML document. <a href="#ga5f0306abe9bff373b5bc339913b3769c">More...</a><br/></td></tr>
157 <tr class="separator:ga5f0306abe9bff373b5bc339913b3769c"><td class="memSeparator" colspan="2"> </td></tr>
158 <tr class="memitem:gacaf24456e2bf85bc5654cbd7d828055f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__emitter.html#gacaf24456e2bf85bc5654cbd7d828055f">yaml_emitter_flush</a> (<a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> *emitter)</td></tr>
159 <tr class="memdesc:gacaf24456e2bf85bc5654cbd7d828055f"><td class="mdescLeft"> </td><td class="mdescRight">Flush the accumulated characters to the output. <a href="#gacaf24456e2bf85bc5654cbd7d828055f">More...</a><br/></td></tr>
160 <tr class="separator:gacaf24456e2bf85bc5654cbd7d828055f"><td class="memSeparator" colspan="2"> </td></tr>
162 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
163 <h2 class="groupheader">Typedef Documentation</h2>
164 <a class="anchor" id="ga1669659aacbe631ad406c78fce1f5379"></a>
165 <div class="memitem">
166 <div class="memproto">
167 <table class="memname">
169 <td class="memname">typedef int yaml_write_handler_t(void *data, unsigned char *buffer, size_t size)</td>
172 </div><div class="memdoc">
174 <p>The prototype of a write handler. </p>
175 <p>The write handler is called when the emitter needs to flush the accumulated characters to the output. The handler should write <em>size</em> bytes of the <em>buffer</em> to the output.</p>
176 <dl class="params"><dt>Parameters</dt><dd>
177 <table class="params">
178 <tr><td class="paramdir">[in,out]</td><td class="paramname">data</td><td>A pointer to an application data specified by <a class="el" href="group__emitter.html#gac85a6a212ed7b469fb426a3451d15922" title="Set a generic output handler. ">yaml_emitter_set_output()</a>. </td></tr>
179 <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer with bytes to be written. </td></tr>
180 <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer.</td></tr>
184 <dl class="section return"><dt>Returns</dt><dd>On success, the handler should return <code>1</code>. If the handler failed, the returned value should be <code>0</code>. </dd></dl>
188 <a class="anchor" id="ga0889461fa3efe8eee881aef48a4ba6b2"></a>
189 <div class="memitem">
190 <div class="memproto">
191 <table class="memname">
193 <td class="memname">typedef enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a> <a class="el" href="group__emitter.html#ga0889461fa3efe8eee881aef48a4ba6b2">yaml_emitter_state_t</a></td>
196 </div><div class="memdoc">
198 <p>The emitter states. </p>
202 <a class="anchor" id="ga4ce3e054f0016c49d9e8c36d359e710b"></a>
203 <div class="memitem">
204 <div class="memproto">
205 <table class="memname">
207 <td class="memname">typedef struct <a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a> <a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a></td>
210 </div><div class="memdoc">
212 <p>The emitter structure. </p>
213 <p>All members are internal. Manage the structure using the <code>yaml_emitter_</code> family of functions. </p>
217 <h2 class="groupheader">Enumeration Type Documentation</h2>
218 <a class="anchor" id="ga387b79da11c3941e43a56947263aa721"></a>
219 <div class="memitem">
220 <div class="memproto">
221 <table class="memname">
223 <td class="memname">enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a></td>
226 </div><div class="memdoc">
228 <p>The emitter states. </p>
229 <table class="fieldtable">
230 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d"></a>YAML_EMIT_STREAM_START_STATE</em> </td><td class="fielddoc">
231 <p>Expect STREAM-START. </p>
233 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae"></a>YAML_EMIT_FIRST_DOCUMENT_START_STATE</em> </td><td class="fielddoc">
234 <p>Expect the first DOCUMENT-START or STREAM-END. </p>
236 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f"></a>YAML_EMIT_DOCUMENT_START_STATE</em> </td><td class="fielddoc">
237 <p>Expect DOCUMENT-START or STREAM-END. </p>
239 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec"></a>YAML_EMIT_DOCUMENT_CONTENT_STATE</em> </td><td class="fielddoc">
240 <p>Expect the content of a document. </p>
242 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3"></a>YAML_EMIT_DOCUMENT_END_STATE</em> </td><td class="fielddoc">
243 <p>Expect DOCUMENT-END. </p>
245 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654"></a>YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</em> </td><td class="fielddoc">
246 <p>Expect the first item of a flow sequence. </p>
248 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767"></a>YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</em> </td><td class="fielddoc">
249 <p>Expect an item of a flow sequence. </p>
251 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894"></a>YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</em> </td><td class="fielddoc">
252 <p>Expect the first key of a flow mapping. </p>
254 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626"></a>YAML_EMIT_FLOW_MAPPING_KEY_STATE</em> </td><td class="fielddoc">
255 <p>Expect a key of a flow mapping. </p>
257 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383"></a>YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</em> </td><td class="fielddoc">
258 <p>Expect a value for a simple key of a flow mapping. </p>
260 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e"></a>YAML_EMIT_FLOW_MAPPING_VALUE_STATE</em> </td><td class="fielddoc">
261 <p>Expect a value of a flow mapping. </p>
263 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d"></a>YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</em> </td><td class="fielddoc">
264 <p>Expect the first item of a block sequence. </p>
266 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff"></a>YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</em> </td><td class="fielddoc">
267 <p>Expect an item of a block sequence. </p>
269 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e"></a>YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</em> </td><td class="fielddoc">
270 <p>Expect the first key of a block mapping. </p>
272 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05"></a>YAML_EMIT_BLOCK_MAPPING_KEY_STATE</em> </td><td class="fielddoc">
273 <p>Expect the key of a block mapping. </p>
275 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704"></a>YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</em> </td><td class="fielddoc">
276 <p>Expect a value for a simple key of a block mapping. </p>
278 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564"></a>YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</em> </td><td class="fielddoc">
279 <p>Expect a value of a block mapping. </p>
281 <tr><td class="fieldname"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0"></a>YAML_EMIT_END_STATE</em> </td><td class="fielddoc">
282 <p>Expect nothing. </p>
288 <h2 class="groupheader">Function Documentation</h2>
289 <a class="anchor" id="ga83649205374285802fc27aa293ecd111"></a>
290 <div class="memitem">
291 <div class="memproto">
292 <table class="memname">
294 <td class="memname">int yaml_emitter_initialize </td>
296 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
297 <td class="paramname"><em>emitter</em></td><td>)</td>
301 </div><div class="memdoc">
303 <p>Initialize an emitter. </p>
304 <p>This function creates a new emitter object. An application is responsible for destroying the object using the <a class="el" href="group__emitter.html#gad705212f3a5150e3f00075fd90bc8c3d" title="Destroy an emitter. ">yaml_emitter_delete()</a> function.</p>
305 <dl class="params"><dt>Parameters</dt><dd>
306 <table class="params">
307 <tr><td class="paramdir">[out]</td><td class="paramname">emitter</td><td>An empty parser object.</td></tr>
311 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
315 <a class="anchor" id="gad705212f3a5150e3f00075fd90bc8c3d"></a>
316 <div class="memitem">
317 <div class="memproto">
318 <table class="memname">
320 <td class="memname">void yaml_emitter_delete </td>
322 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
323 <td class="paramname"><em>emitter</em></td><td>)</td>
327 </div><div class="memdoc">
329 <p>Destroy an emitter. </p>
330 <dl class="params"><dt>Parameters</dt><dd>
331 <table class="params">
332 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
339 <a class="anchor" id="ga62725c0f616f634588374d1a4c0ed35a"></a>
340 <div class="memitem">
341 <div class="memproto">
342 <table class="memname">
344 <td class="memname">void yaml_emitter_set_output_string </td>
346 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
347 <td class="paramname"><em>emitter</em>, </td>
350 <td class="paramkey"></td>
352 <td class="paramtype">unsigned char * </td>
353 <td class="paramname"><em>output</em>, </td>
356 <td class="paramkey"></td>
358 <td class="paramtype">size_t </td>
359 <td class="paramname"><em>size</em>, </td>
362 <td class="paramkey"></td>
364 <td class="paramtype">size_t * </td>
365 <td class="paramname"><em>size_written</em> </td>
373 </div><div class="memdoc">
375 <p>Set a string output. </p>
376 <p>The emitter will write the output characters to the <em>output</em> buffer of the size <em>size</em>. The emitter will set <em>size_written</em> to the number of written bytes. If the buffer is smaller than required, the emitter produces the YAML_WRITE_ERROR error.</p>
377 <dl class="params"><dt>Parameters</dt><dd>
378 <table class="params">
379 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
380 <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>An output buffer. </td></tr>
381 <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The buffer size. </td></tr>
382 <tr><td class="paramdir">[in]</td><td class="paramname">size_written</td><td>The pointer to save the number of written bytes. </td></tr>
389 <a class="anchor" id="gaf7610c61b303bde9c701024c10ece024"></a>
390 <div class="memitem">
391 <div class="memproto">
392 <table class="memname">
394 <td class="memname">void yaml_emitter_set_output_file </td>
396 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
397 <td class="paramname"><em>emitter</em>, </td>
400 <td class="paramkey"></td>
402 <td class="paramtype">FILE * </td>
403 <td class="paramname"><em>file</em> </td>
411 </div><div class="memdoc">
413 <p>Set a file output. </p>
414 <p><em>file</em> should be a file object open for writing. The application is responsible for closing the <em>file</em>.</p>
415 <dl class="params"><dt>Parameters</dt><dd>
416 <table class="params">
417 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
418 <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>An open file. </td></tr>
425 <a class="anchor" id="gac85a6a212ed7b469fb426a3451d15922"></a>
426 <div class="memitem">
427 <div class="memproto">
428 <table class="memname">
430 <td class="memname">void yaml_emitter_set_output </td>
432 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
433 <td class="paramname"><em>emitter</em>, </td>
436 <td class="paramkey"></td>
438 <td class="paramtype"><a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> * </td>
439 <td class="paramname"><em>handler</em>, </td>
442 <td class="paramkey"></td>
444 <td class="paramtype">void * </td>
445 <td class="paramname"><em>data</em> </td>
453 </div><div class="memdoc">
455 <p>Set a generic output handler. </p>
456 <dl class="params"><dt>Parameters</dt><dd>
457 <table class="params">
458 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
459 <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>A write handler. </td></tr>
460 <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Any application data for passing to the write handler. </td></tr>
467 <a class="anchor" id="gabc22888ec8bf942199acbf38f7a0b9bb"></a>
468 <div class="memitem">
469 <div class="memproto">
470 <table class="memname">
472 <td class="memname">void yaml_emitter_set_encoding </td>
474 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
475 <td class="paramname"><em>emitter</em>, </td>
478 <td class="paramkey"></td>
480 <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> </td>
481 <td class="paramname"><em>encoding</em> </td>
489 </div><div class="memdoc">
491 <p>Set the output encoding. </p>
492 <dl class="params"><dt>Parameters</dt><dd>
493 <table class="params">
494 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
495 <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The output encoding. </td></tr>
502 <a class="anchor" id="ga62713a8130e11d95cbefa95a2eb3ac4b"></a>
503 <div class="memitem">
504 <div class="memproto">
505 <table class="memname">
507 <td class="memname">void yaml_emitter_set_canonical </td>
509 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
510 <td class="paramname"><em>emitter</em>, </td>
513 <td class="paramkey"></td>
515 <td class="paramtype">int </td>
516 <td class="paramname"><em>canonical</em> </td>
524 </div><div class="memdoc">
526 <p>Set if the output should be in the "canonical" format as in the YAML specification. </p>
527 <dl class="params"><dt>Parameters</dt><dd>
528 <table class="params">
529 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
530 <tr><td class="paramdir">[in]</td><td class="paramname">canonical</td><td>If the output is canonical. </td></tr>
537 <a class="anchor" id="ga07eca3c344053a9028b4a84291cdf4d7"></a>
538 <div class="memitem">
539 <div class="memproto">
540 <table class="memname">
542 <td class="memname">void yaml_emitter_set_indent </td>
544 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
545 <td class="paramname"><em>emitter</em>, </td>
548 <td class="paramkey"></td>
550 <td class="paramtype">int </td>
551 <td class="paramname"><em>indent</em> </td>
559 </div><div class="memdoc">
561 <p>Set the intendation increment. </p>
562 <dl class="params"><dt>Parameters</dt><dd>
563 <table class="params">
564 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
565 <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>The indentation increment (1 < . < 10). </td></tr>
572 <a class="anchor" id="gaa91ae0fa8af5ab67e64567e08f4458c2"></a>
573 <div class="memitem">
574 <div class="memproto">
575 <table class="memname">
577 <td class="memname">void yaml_emitter_set_width </td>
579 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
580 <td class="paramname"><em>emitter</em>, </td>
583 <td class="paramkey"></td>
585 <td class="paramtype">int </td>
586 <td class="paramname"><em>width</em> </td>
594 </div><div class="memdoc">
596 <p>Set the preferred line width. </p>
597 <p><code>-1</code> means unlimited.</p>
598 <dl class="params"><dt>Parameters</dt><dd>
599 <table class="params">
600 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
601 <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The preferred line width. </td></tr>
608 <a class="anchor" id="gaa59e7dcf24cb9b614c32af6c3e949fc3"></a>
609 <div class="memitem">
610 <div class="memproto">
611 <table class="memname">
613 <td class="memname">void yaml_emitter_set_unicode </td>
615 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
616 <td class="paramname"><em>emitter</em>, </td>
619 <td class="paramkey"></td>
621 <td class="paramtype">int </td>
622 <td class="paramname"><em>unicode</em> </td>
630 </div><div class="memdoc">
632 <p>Set if unescaped non-ASCII characters are allowed. </p>
633 <dl class="params"><dt>Parameters</dt><dd>
634 <table class="params">
635 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
636 <tr><td class="paramdir">[in]</td><td class="paramname">unicode</td><td>If unescaped Unicode characters are allowed. </td></tr>
643 <a class="anchor" id="ga04b5494f0b8244eec359579c31d5e20c"></a>
644 <div class="memitem">
645 <div class="memproto">
646 <table class="memname">
648 <td class="memname">void yaml_emitter_set_break </td>
650 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
651 <td class="paramname"><em>emitter</em>, </td>
654 <td class="paramkey"></td>
656 <td class="paramtype"><a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> </td>
657 <td class="paramname"><em>line_break</em> </td>
665 </div><div class="memdoc">
667 <p>Set the preferred line break. </p>
668 <dl class="params"><dt>Parameters</dt><dd>
669 <table class="params">
670 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
671 <tr><td class="paramdir">[in]</td><td class="paramname">line_break</td><td>The preferred line break. </td></tr>
678 <a class="anchor" id="ga4d6c0f8e712797e2660e69479fdae433"></a>
679 <div class="memitem">
680 <div class="memproto">
681 <table class="memname">
683 <td class="memname">int yaml_emitter_emit </td>
685 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
686 <td class="paramname"><em>emitter</em>, </td>
689 <td class="paramkey"></td>
691 <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td>
692 <td class="paramname"><em>event</em> </td>
700 </div><div class="memdoc">
702 <p>Emit an event. </p>
703 <p>The event object may be generated using the <a class="el" href="group__parser.html#ga559312fb137533d8b7e07f224fe0ec8f" title="Parse the input stream and produce the next parsing event. ">yaml_parser_parse()</a> function. The emitter takes the responsibility for the event object and destroys its content after it is emitted. The event object is destroyed even if the function fails.</p>
704 <dl class="params"><dt>Parameters</dt><dd>
705 <table class="params">
706 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
707 <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object.</td></tr>
711 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
715 <a class="anchor" id="gae323c34e378040106f24c7b5ab834b16"></a>
716 <div class="memitem">
717 <div class="memproto">
718 <table class="memname">
720 <td class="memname">int yaml_emitter_open </td>
722 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
723 <td class="paramname"><em>emitter</em></td><td>)</td>
727 </div><div class="memdoc">
729 <p>Start a YAML stream. </p>
730 <p>This function should be used before <a class="el" href="group__emitter.html#ga5f0306abe9bff373b5bc339913b3769c" title="Emit a YAML document. ">yaml_emitter_dump()</a> is called.</p>
731 <dl class="params"><dt>Parameters</dt><dd>
732 <table class="params">
733 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr>
737 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
741 <a class="anchor" id="gaa91442864679280985df14b2d96b8c42"></a>
742 <div class="memitem">
743 <div class="memproto">
744 <table class="memname">
746 <td class="memname">int yaml_emitter_close </td>
748 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
749 <td class="paramname"><em>emitter</em></td><td>)</td>
753 </div><div class="memdoc">
755 <p>Finish a YAML stream. </p>
756 <p>This function should be used after <a class="el" href="group__emitter.html#ga5f0306abe9bff373b5bc339913b3769c" title="Emit a YAML document. ">yaml_emitter_dump()</a> is called.</p>
757 <dl class="params"><dt>Parameters</dt><dd>
758 <table class="params">
759 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr>
763 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
767 <a class="anchor" id="ga5f0306abe9bff373b5bc339913b3769c"></a>
768 <div class="memitem">
769 <div class="memproto">
770 <table class="memname">
772 <td class="memname">int yaml_emitter_dump </td>
774 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
775 <td class="paramname"><em>emitter</em>, </td>
778 <td class="paramkey"></td>
780 <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td>
781 <td class="paramname"><em>document</em> </td>
789 </div><div class="memdoc">
791 <p>Emit a YAML document. </p>
792 <p>The documen object may be generated using the <a class="el" href="group__parser.html#ga9ef7d6e9494766b5880c389bc431d138" title="Parse the input stream and produce the next YAML document. ">yaml_parser_load()</a> function or the <a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89" title="Create a YAML document. ">yaml_document_initialize()</a> function. The emitter takes the responsibility for the document object and destoys its content after it is emitted. The document object is destroyedeven if the function fails.</p>
793 <dl class="params"><dt>Parameters</dt><dd>
794 <table class="params">
795 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr>
796 <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object.</td></tr>
800 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
804 <a class="anchor" id="gacaf24456e2bf85bc5654cbd7d828055f"></a>
805 <div class="memitem">
806 <div class="memproto">
807 <table class="memname">
809 <td class="memname">int yaml_emitter_flush </td>
811 <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td>
812 <td class="paramname"><em>emitter</em></td><td>)</td>
816 </div><div class="memdoc">
818 <p>Flush the accumulated characters to the output. </p>
819 <dl class="params"><dt>Parameters</dt><dd>
820 <table class="params">
821 <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr>
825 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
829 </div><!-- contents -->
830 <!-- start footer part -->
831 <hr class="footer"/><address class="footer"><small>
832 Generated on Sun Aug 28 2016 23:56:54 for yaml by  <a href="http://www.doxygen.org/index.html">
833 <img class="footer" src="doxygen.png" alt="doxygen"/>