]>
Commit | Line | Data |
---|---|---|
0fbeb4dc AK |
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"/> | |
059850b5 | 5 | <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
c45550e5 AK |
6 | <meta name="generator" content="Doxygen 1.8.14"/> |
7 | <meta name="viewport" content="width=device-width, initial-scale=1"/> | |
b9668ba4 | 8 | <title>yaml: Emitter Definitions</title> |
0fbeb4dc | 9 | <link href="tabs.css" rel="stylesheet" type="text/css"/> |
0044e680 AK |
10 | <script type="text/javascript" src="jquery.js"></script> |
11 | <script type="text/javascript" src="dynsections.js"></script> | |
059850b5 | 12 | <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
0fbeb4dc AK |
13 | </head> |
14 | <body> | |
0044e680 | 15 | <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
059850b5 AK |
16 | <div id="titlearea"> |
17 | <table cellspacing="0" cellpadding="0"> | |
18 | <tbody> | |
19 | <tr style="height: 56px;"> | |
c45550e5 | 20 | <td id="projectalign" style="padding-left: 0.5em;"> |
059850b5 | 21 | <div id="projectname">yaml |
5070705b | 22 |  <span id="projectnumber">0.2.2</span> |
059850b5 | 23 | </div> |
059850b5 | 24 | </td> |
059850b5 AK |
25 | </tr> |
26 | </tbody> | |
27 | </table> | |
28 | </div> | |
0044e680 | 29 | <!-- end header part --> |
c45550e5 AK |
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 */ | |
35 | $(function() { | |
36 | initMenu('',false,false,'search.php','Search'); | |
37 | }); | |
38 | /* @license-end */</script> | |
39 | <div id="main-nav"></div> | |
0044e680 | 40 | </div><!-- top --> |
0fbeb4dc AK |
41 | <div class="header"> |
42 | <div class="summary"> | |
43 | <a href="#nested-classes">Data Structures</a> | | |
44 | <a href="#typedef-members">Typedefs</a> | | |
45 | <a href="#enum-members">Enumerations</a> | | |
46 | <a href="#func-members">Functions</a> </div> | |
47 | <div class="headertitle"> | |
059850b5 AK |
48 | <div class="title">Emitter Definitions</div> </div> |
49 | </div><!--header--> | |
5c706339 | 50 | <div class="contents"> |
0fbeb4dc | 51 | <table class="memberdecls"> |
0044e680 | 52 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> |
0fbeb4dc | 53 | Data Structures</h2></td></tr> |
5070705b AK |
54 | <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__anchors__s.html">yaml_anchors_s</a></td></tr> |
55 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> | |
0044e680 | 56 | <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> |
c45550e5 | 57 | <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> |
0044e680 AK |
58 | <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> |
59 | </table><table class="memberdecls"> | |
60 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> | |
0fbeb4dc | 61 | Typedefs</h2></td></tr> |
c45550e5 AK |
62 | <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> |
63 | <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> | |
0044e680 AK |
64 | <tr class="separator:ga1669659aacbe631ad406c78fce1f5379"><td class="memSeparator" colspan="2"> </td></tr> |
65 | <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> | |
c45550e5 | 66 | <tr class="memdesc:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="mdescLeft"> </td><td class="mdescRight">The emitter states. <a href="#ga0889461fa3efe8eee881aef48a4ba6b2">More...</a><br /></td></tr> |
0044e680 | 67 | <tr class="separator:ga0889461fa3efe8eee881aef48a4ba6b2"><td class="memSeparator" colspan="2"> </td></tr> |
5070705b AK |
68 | <tr class="memitem:ga4086f2799cbee6055a032d55488cb280"><td class="memItemLeft" align="right" valign="top"><a id="ga4086f2799cbee6055a032d55488cb280"></a> |
69 | typedef struct <a class="el" href="structyaml__anchors__s.html">yaml_anchors_s</a> </td><td class="memItemRight" valign="bottom"><b>yaml_anchors_t</b></td></tr> | |
70 | <tr class="separator:ga4086f2799cbee6055a032d55488cb280"><td class="memSeparator" colspan="2"> </td></tr> | |
0044e680 | 71 | <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> |
c45550e5 | 72 | <tr class="memdesc:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="#ga4ce3e054f0016c49d9e8c36d359e710b">More...</a><br /></td></tr> |
0044e680 AK |
73 | <tr class="separator:ga4ce3e054f0016c49d9e8c36d359e710b"><td class="memSeparator" colspan="2"> </td></tr> |
74 | </table><table class="memberdecls"> | |
75 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> | |
0fbeb4dc | 76 | Enumerations</h2></td></tr> |
c45550e5 | 77 | <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 /> |
059850b5 | 78 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d">YAML_EMIT_STREAM_START_STATE</a>, |
c45550e5 | 79 | <br /> |
059850b5 | 80 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae">YAML_EMIT_FIRST_DOCUMENT_START_STATE</a>, |
c45550e5 | 81 | <br /> |
059850b5 | 82 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f">YAML_EMIT_DOCUMENT_START_STATE</a>, |
c45550e5 | 83 | <br /> |
059850b5 | 84 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec">YAML_EMIT_DOCUMENT_CONTENT_STATE</a>, |
c45550e5 | 85 | <br /> |
059850b5 | 86 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3">YAML_EMIT_DOCUMENT_END_STATE</a>, |
c45550e5 | 87 | <br /> |
059850b5 | 88 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654">YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</a>, |
c45550e5 | 89 | <br /> |
059850b5 | 90 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767">YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</a>, |
c45550e5 | 91 | <br /> |
059850b5 | 92 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894">YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</a>, |
c45550e5 | 93 | <br /> |
059850b5 | 94 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626">YAML_EMIT_FLOW_MAPPING_KEY_STATE</a>, |
c45550e5 | 95 | <br /> |
059850b5 | 96 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383">YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</a>, |
c45550e5 | 97 | <br /> |
059850b5 | 98 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e">YAML_EMIT_FLOW_MAPPING_VALUE_STATE</a>, |
c45550e5 | 99 | <br /> |
059850b5 | 100 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d">YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</a>, |
c45550e5 | 101 | <br /> |
059850b5 | 102 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff">YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</a>, |
c45550e5 | 103 | <br /> |
059850b5 | 104 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e">YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</a>, |
c45550e5 | 105 | <br /> |
059850b5 | 106 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05">YAML_EMIT_BLOCK_MAPPING_KEY_STATE</a>, |
c45550e5 | 107 | <br /> |
059850b5 | 108 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704">YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</a>, |
c45550e5 | 109 | <br /> |
059850b5 | 110 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564">YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</a>, |
c45550e5 | 111 | <br /> |
059850b5 | 112 |   <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0">YAML_EMIT_END_STATE</a> |
c45550e5 | 113 | <br /> |
b9668ba4 | 114 | }</td></tr> |
c45550e5 | 115 | <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> |
0044e680 AK |
116 | <tr class="separator:ga387b79da11c3941e43a56947263aa721"><td class="memSeparator" colspan="2"> </td></tr> |
117 | </table><table class="memberdecls"> | |
118 | <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> | |
0fbeb4dc | 119 | Functions</h2></td></tr> |
0044e680 | 120 | <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> |
c45550e5 | 121 | <tr class="memdesc:ga83649205374285802fc27aa293ecd111"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an emitter. <a href="#ga83649205374285802fc27aa293ecd111">More...</a><br /></td></tr> |
0044e680 AK |
122 | <tr class="separator:ga83649205374285802fc27aa293ecd111"><td class="memSeparator" colspan="2"> </td></tr> |
123 | <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> | |
c45550e5 | 124 | <tr class="memdesc:gad705212f3a5150e3f00075fd90bc8c3d"><td class="mdescLeft"> </td><td class="mdescRight">Destroy an emitter. <a href="#gad705212f3a5150e3f00075fd90bc8c3d">More...</a><br /></td></tr> |
0044e680 AK |
125 | <tr class="separator:gad705212f3a5150e3f00075fd90bc8c3d"><td class="memSeparator" colspan="2"> </td></tr> |
126 | <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> | |
c45550e5 | 127 | <tr class="memdesc:ga62725c0f616f634588374d1a4c0ed35a"><td class="mdescLeft"> </td><td class="mdescRight">Set a string output. <a href="#ga62725c0f616f634588374d1a4c0ed35a">More...</a><br /></td></tr> |
0044e680 AK |
128 | <tr class="separator:ga62725c0f616f634588374d1a4c0ed35a"><td class="memSeparator" colspan="2"> </td></tr> |
129 | <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> | |
c45550e5 | 130 | <tr class="memdesc:gaf7610c61b303bde9c701024c10ece024"><td class="mdescLeft"> </td><td class="mdescRight">Set a file output. <a href="#gaf7610c61b303bde9c701024c10ece024">More...</a><br /></td></tr> |
0044e680 AK |
131 | <tr class="separator:gaf7610c61b303bde9c701024c10ece024"><td class="memSeparator" colspan="2"> </td></tr> |
132 | <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> | |
c45550e5 | 133 | <tr class="memdesc:gac85a6a212ed7b469fb426a3451d15922"><td class="mdescLeft"> </td><td class="mdescRight">Set a generic output handler. <a href="#gac85a6a212ed7b469fb426a3451d15922">More...</a><br /></td></tr> |
0044e680 AK |
134 | <tr class="separator:gac85a6a212ed7b469fb426a3451d15922"><td class="memSeparator" colspan="2"> </td></tr> |
135 | <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> | |
c45550e5 | 136 | <tr class="memdesc:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="mdescLeft"> </td><td class="mdescRight">Set the output encoding. <a href="#gabc22888ec8bf942199acbf38f7a0b9bb">More...</a><br /></td></tr> |
0044e680 AK |
137 | <tr class="separator:gabc22888ec8bf942199acbf38f7a0b9bb"><td class="memSeparator" colspan="2"> </td></tr> |
138 | <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> | |
c45550e5 | 139 | <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> |
0044e680 AK |
140 | <tr class="separator:ga62713a8130e11d95cbefa95a2eb3ac4b"><td class="memSeparator" colspan="2"> </td></tr> |
141 | <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> | |
c45550e5 | 142 | <tr class="memdesc:ga07eca3c344053a9028b4a84291cdf4d7"><td class="mdescLeft"> </td><td class="mdescRight">Set the intendation increment. <a href="#ga07eca3c344053a9028b4a84291cdf4d7">More...</a><br /></td></tr> |
0044e680 AK |
143 | <tr class="separator:ga07eca3c344053a9028b4a84291cdf4d7"><td class="memSeparator" colspan="2"> </td></tr> |
144 | <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> | |
c45550e5 | 145 | <tr class="memdesc:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line width. <a href="#gaa91ae0fa8af5ab67e64567e08f4458c2">More...</a><br /></td></tr> |
0044e680 AK |
146 | <tr class="separator:gaa91ae0fa8af5ab67e64567e08f4458c2"><td class="memSeparator" colspan="2"> </td></tr> |
147 | <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> | |
c45550e5 | 148 | <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> |
0044e680 AK |
149 | <tr class="separator:gaa59e7dcf24cb9b614c32af6c3e949fc3"><td class="memSeparator" colspan="2"> </td></tr> |
150 | <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> | |
c45550e5 | 151 | <tr class="memdesc:ga04b5494f0b8244eec359579c31d5e20c"><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line break. <a href="#ga04b5494f0b8244eec359579c31d5e20c">More...</a><br /></td></tr> |
0044e680 AK |
152 | <tr class="separator:ga04b5494f0b8244eec359579c31d5e20c"><td class="memSeparator" colspan="2"> </td></tr> |
153 | <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> | |
c45550e5 | 154 | <tr class="memdesc:ga4d6c0f8e712797e2660e69479fdae433"><td class="mdescLeft"> </td><td class="mdescRight">Emit an event. <a href="#ga4d6c0f8e712797e2660e69479fdae433">More...</a><br /></td></tr> |
0044e680 AK |
155 | <tr class="separator:ga4d6c0f8e712797e2660e69479fdae433"><td class="memSeparator" colspan="2"> </td></tr> |
156 | <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> | |
c45550e5 | 157 | <tr class="memdesc:gae323c34e378040106f24c7b5ab834b16"><td class="mdescLeft"> </td><td class="mdescRight">Start a YAML stream. <a href="#gae323c34e378040106f24c7b5ab834b16">More...</a><br /></td></tr> |
0044e680 AK |
158 | <tr class="separator:gae323c34e378040106f24c7b5ab834b16"><td class="memSeparator" colspan="2"> </td></tr> |
159 | <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> | |
c45550e5 | 160 | <tr class="memdesc:gaa91442864679280985df14b2d96b8c42"><td class="mdescLeft"> </td><td class="mdescRight">Finish a YAML stream. <a href="#gaa91442864679280985df14b2d96b8c42">More...</a><br /></td></tr> |
0044e680 AK |
161 | <tr class="separator:gaa91442864679280985df14b2d96b8c42"><td class="memSeparator" colspan="2"> </td></tr> |
162 | <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> | |
c45550e5 | 163 | <tr class="memdesc:ga5f0306abe9bff373b5bc339913b3769c"><td class="mdescLeft"> </td><td class="mdescRight">Emit a YAML document. <a href="#ga5f0306abe9bff373b5bc339913b3769c">More...</a><br /></td></tr> |
0044e680 AK |
164 | <tr class="separator:ga5f0306abe9bff373b5bc339913b3769c"><td class="memSeparator" colspan="2"> </td></tr> |
165 | <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> | |
c45550e5 | 166 | <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> |
0044e680 | 167 | <tr class="separator:gacaf24456e2bf85bc5654cbd7d828055f"><td class="memSeparator" colspan="2"> </td></tr> |
b9668ba4 | 168 | </table> |
0044e680 AK |
169 | <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
170 | <h2 class="groupheader">Typedef Documentation</h2> | |
c45550e5 AK |
171 | <a id="ga1669659aacbe631ad406c78fce1f5379"></a> |
172 | <h2 class="memtitle"><span class="permalink"><a href="#ga1669659aacbe631ad406c78fce1f5379">◆ </a></span>yaml_write_handler_t</h2> | |
173 | ||
b9668ba4 AK |
174 | <div class="memitem"> |
175 | <div class="memproto"> | |
176 | <table class="memname"> | |
177 | <tr> | |
0044e680 | 178 | <td class="memname">typedef int yaml_write_handler_t(void *data, unsigned char *buffer, size_t size)</td> |
b9668ba4 AK |
179 | </tr> |
180 | </table> | |
0044e680 | 181 | </div><div class="memdoc"> |
b9668ba4 | 182 | |
0fbeb4dc AK |
183 | <p>The prototype of a write handler. </p> |
184 | <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> | |
0044e680 | 185 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 | 186 | <table class="params"> |
0044e680 | 187 | <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> |
059850b5 AK |
188 | <tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>The buffer with bytes to be written. </td></tr> |
189 | <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The size of the buffer.</td></tr> | |
b9668ba4 | 190 | </table> |
0fbeb4dc | 191 | </dd> |
b9668ba4 | 192 | </dl> |
0044e680 | 193 | <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> |
b9668ba4 | 194 | |
5c706339 | 195 | </div> |
0fbeb4dc | 196 | </div> |
c45550e5 AK |
197 | <a id="ga0889461fa3efe8eee881aef48a4ba6b2"></a> |
198 | <h2 class="memtitle"><span class="permalink"><a href="#ga0889461fa3efe8eee881aef48a4ba6b2">◆ </a></span>yaml_emitter_state_t</h2> | |
199 | ||
5c706339 AK |
200 | <div class="memitem"> |
201 | <div class="memproto"> | |
202 | <table class="memname"> | |
203 | <tr> | |
0fbeb4dc | 204 | <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> |
5c706339 AK |
205 | </tr> |
206 | </table> | |
0044e680 | 207 | </div><div class="memdoc"> |
5c706339 | 208 | |
0fbeb4dc | 209 | <p>The emitter states. </p> |
5c706339 | 210 | |
b9668ba4 | 211 | </div> |
0fbeb4dc | 212 | </div> |
c45550e5 AK |
213 | <a id="ga4ce3e054f0016c49d9e8c36d359e710b"></a> |
214 | <h2 class="memtitle"><span class="permalink"><a href="#ga4ce3e054f0016c49d9e8c36d359e710b">◆ </a></span>yaml_emitter_t</h2> | |
215 | ||
b9668ba4 AK |
216 | <div class="memitem"> |
217 | <div class="memproto"> | |
218 | <table class="memname"> | |
219 | <tr> | |
059850b5 | 220 | <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> |
b9668ba4 AK |
221 | </tr> |
222 | </table> | |
0044e680 | 223 | </div><div class="memdoc"> |
b9668ba4 | 224 | |
0fbeb4dc AK |
225 | <p>The emitter structure. </p> |
226 | <p>All members are internal. Manage the structure using the <code>yaml_emitter_</code> family of functions. </p> | |
227 | ||
228 | </div> | |
b9668ba4 | 229 | </div> |
0044e680 | 230 | <h2 class="groupheader">Enumeration Type Documentation</h2> |
c45550e5 AK |
231 | <a id="ga387b79da11c3941e43a56947263aa721"></a> |
232 | <h2 class="memtitle"><span class="permalink"><a href="#ga387b79da11c3941e43a56947263aa721">◆ </a></span>yaml_emitter_state_e</h2> | |
233 | ||
b9668ba4 AK |
234 | <div class="memitem"> |
235 | <div class="memproto"> | |
236 | <table class="memname"> | |
237 | <tr> | |
0fbeb4dc | 238 | <td class="memname">enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a></td> |
b9668ba4 AK |
239 | </tr> |
240 | </table> | |
0044e680 | 241 | </div><div class="memdoc"> |
b9668ba4 | 242 | |
0fbeb4dc | 243 | <p>The emitter states. </p> |
0044e680 | 244 | <table class="fieldtable"> |
c45550e5 | 245 | <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d"></a>YAML_EMIT_STREAM_START_STATE </td><td class="fielddoc"><p>Expect STREAM-START. </p> |
5c706339 | 246 | </td></tr> |
c45550e5 | 247 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae"></a>YAML_EMIT_FIRST_DOCUMENT_START_STATE </td><td class="fielddoc"><p>Expect the first DOCUMENT-START or STREAM-END. </p> |
5c706339 | 248 | </td></tr> |
c45550e5 | 249 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f"></a>YAML_EMIT_DOCUMENT_START_STATE </td><td class="fielddoc"><p>Expect DOCUMENT-START or STREAM-END. </p> |
5c706339 | 250 | </td></tr> |
c45550e5 | 251 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec"></a>YAML_EMIT_DOCUMENT_CONTENT_STATE </td><td class="fielddoc"><p>Expect the content of a document. </p> |
5c706339 | 252 | </td></tr> |
c45550e5 | 253 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3"></a>YAML_EMIT_DOCUMENT_END_STATE </td><td class="fielddoc"><p>Expect DOCUMENT-END. </p> |
5c706339 | 254 | </td></tr> |
c45550e5 | 255 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654"></a>YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE </td><td class="fielddoc"><p>Expect the first item of a flow sequence. </p> |
5c706339 | 256 | </td></tr> |
c45550e5 | 257 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767"></a>YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE </td><td class="fielddoc"><p>Expect an item of a flow sequence. </p> |
5c706339 | 258 | </td></tr> |
c45550e5 | 259 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894"></a>YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE </td><td class="fielddoc"><p>Expect the first key of a flow mapping. </p> |
5c706339 | 260 | </td></tr> |
c45550e5 | 261 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626"></a>YAML_EMIT_FLOW_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect a key of a flow mapping. </p> |
5c706339 | 262 | </td></tr> |
c45550e5 | 263 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383"></a>YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE </td><td class="fielddoc"><p>Expect a value for a simple key of a flow mapping. </p> |
5c706339 | 264 | </td></tr> |
c45550e5 | 265 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e"></a>YAML_EMIT_FLOW_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a value of a flow mapping. </p> |
5c706339 | 266 | </td></tr> |
c45550e5 | 267 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d"></a>YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE </td><td class="fielddoc"><p>Expect the first item of a block sequence. </p> |
5c706339 | 268 | </td></tr> |
c45550e5 | 269 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff"></a>YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE </td><td class="fielddoc"><p>Expect an item of a block sequence. </p> |
5c706339 | 270 | </td></tr> |
c45550e5 | 271 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e"></a>YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE </td><td class="fielddoc"><p>Expect the first key of a block mapping. </p> |
5c706339 | 272 | </td></tr> |
c45550e5 | 273 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05"></a>YAML_EMIT_BLOCK_MAPPING_KEY_STATE </td><td class="fielddoc"><p>Expect the key of a block mapping. </p> |
5c706339 | 274 | </td></tr> |
c45550e5 | 275 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704"></a>YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE </td><td class="fielddoc"><p>Expect a value for a simple key of a block mapping. </p> |
5c706339 | 276 | </td></tr> |
c45550e5 | 277 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564"></a>YAML_EMIT_BLOCK_MAPPING_VALUE_STATE </td><td class="fielddoc"><p>Expect a value of a block mapping. </p> |
5c706339 | 278 | </td></tr> |
c45550e5 | 279 | <tr><td class="fieldname"><a id="gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0"></a>YAML_EMIT_END_STATE </td><td class="fielddoc"><p>Expect nothing. </p> |
5c706339 | 280 | </td></tr> |
b9668ba4 | 281 | </table> |
b9668ba4 AK |
282 | |
283 | </div> | |
0fbeb4dc | 284 | </div> |
0044e680 | 285 | <h2 class="groupheader">Function Documentation</h2> |
c45550e5 AK |
286 | <a id="ga83649205374285802fc27aa293ecd111"></a> |
287 | <h2 class="memtitle"><span class="permalink"><a href="#ga83649205374285802fc27aa293ecd111">◆ </a></span>yaml_emitter_initialize()</h2> | |
288 | ||
b9668ba4 AK |
289 | <div class="memitem"> |
290 | <div class="memproto"> | |
291 | <table class="memname"> | |
292 | <tr> | |
0044e680 | 293 | <td class="memname">int yaml_emitter_initialize </td> |
b9668ba4 | 294 | <td>(</td> |
059850b5 AK |
295 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
296 | <td class="paramname"><em>emitter</em></td><td>)</td> | |
5c706339 | 297 | <td></td> |
b9668ba4 AK |
298 | </tr> |
299 | </table> | |
0044e680 | 300 | </div><div class="memdoc"> |
b9668ba4 | 301 | |
0fbeb4dc | 302 | <p>Initialize an emitter. </p> |
0044e680 AK |
303 | <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> |
304 | <dl class="params"><dt>Parameters</dt><dd> | |
059850b5 AK |
305 | <table class="params"> |
306 | <tr><td class="paramdir">[out]</td><td class="paramname">emitter</td><td>An empty parser object.</td></tr> | |
b9668ba4 | 307 | </table> |
0fbeb4dc | 308 | </dd> |
b9668ba4 | 309 | </dl> |
0044e680 | 310 | <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
311 | |
312 | </div> | |
0fbeb4dc | 313 | </div> |
c45550e5 AK |
314 | <a id="gad705212f3a5150e3f00075fd90bc8c3d"></a> |
315 | <h2 class="memtitle"><span class="permalink"><a href="#gad705212f3a5150e3f00075fd90bc8c3d">◆ </a></span>yaml_emitter_delete()</h2> | |
316 | ||
b9668ba4 AK |
317 | <div class="memitem"> |
318 | <div class="memproto"> | |
319 | <table class="memname"> | |
320 | <tr> | |
0044e680 | 321 | <td class="memname">void yaml_emitter_delete </td> |
b9668ba4 | 322 | <td>(</td> |
059850b5 AK |
323 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
324 | <td class="paramname"><em>emitter</em></td><td>)</td> | |
5c706339 | 325 | <td></td> |
b9668ba4 AK |
326 | </tr> |
327 | </table> | |
0044e680 | 328 | </div><div class="memdoc"> |
b9668ba4 | 329 | |
0fbeb4dc | 330 | <p>Destroy an emitter. </p> |
0044e680 | 331 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
332 | <table class="params"> |
333 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
b9668ba4 | 334 | </table> |
0fbeb4dc | 335 | </dd> |
b9668ba4 AK |
336 | </dl> |
337 | ||
338 | </div> | |
0fbeb4dc | 339 | </div> |
c45550e5 AK |
340 | <a id="ga62725c0f616f634588374d1a4c0ed35a"></a> |
341 | <h2 class="memtitle"><span class="permalink"><a href="#ga62725c0f616f634588374d1a4c0ed35a">◆ </a></span>yaml_emitter_set_output_string()</h2> | |
342 | ||
b9668ba4 AK |
343 | <div class="memitem"> |
344 | <div class="memproto"> | |
345 | <table class="memname"> | |
346 | <tr> | |
0044e680 | 347 | <td class="memname">void yaml_emitter_set_output_string </td> |
b9668ba4 | 348 | <td>(</td> |
059850b5 AK |
349 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
350 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
351 | </tr> |
352 | <tr> | |
353 | <td class="paramkey"></td> | |
354 | <td></td> | |
059850b5 AK |
355 | <td class="paramtype">unsigned char * </td> |
356 | <td class="paramname"><em>output</em>, </td> | |
b9668ba4 AK |
357 | </tr> |
358 | <tr> | |
359 | <td class="paramkey"></td> | |
360 | <td></td> | |
059850b5 AK |
361 | <td class="paramtype">size_t </td> |
362 | <td class="paramname"><em>size</em>, </td> | |
b9668ba4 AK |
363 | </tr> |
364 | <tr> | |
365 | <td class="paramkey"></td> | |
366 | <td></td> | |
059850b5 AK |
367 | <td class="paramtype">size_t * </td> |
368 | <td class="paramname"><em>size_written</em> </td> | |
b9668ba4 AK |
369 | </tr> |
370 | <tr> | |
371 | <td></td> | |
372 | <td>)</td> | |
059850b5 | 373 | <td></td><td></td> |
b9668ba4 AK |
374 | </tr> |
375 | </table> | |
0044e680 | 376 | </div><div class="memdoc"> |
b9668ba4 | 377 | |
0fbeb4dc AK |
378 | <p>Set a string output. </p> |
379 | <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> | |
0044e680 | 380 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
381 | <table class="params"> |
382 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
383 | <tr><td class="paramdir">[in]</td><td class="paramname">output</td><td>An output buffer. </td></tr> | |
384 | <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>The buffer size. </td></tr> | |
385 | <tr><td class="paramdir">[in]</td><td class="paramname">size_written</td><td>The pointer to save the number of written bytes. </td></tr> | |
b9668ba4 | 386 | </table> |
0fbeb4dc | 387 | </dd> |
b9668ba4 AK |
388 | </dl> |
389 | ||
390 | </div> | |
0fbeb4dc | 391 | </div> |
c45550e5 AK |
392 | <a id="gaf7610c61b303bde9c701024c10ece024"></a> |
393 | <h2 class="memtitle"><span class="permalink"><a href="#gaf7610c61b303bde9c701024c10ece024">◆ </a></span>yaml_emitter_set_output_file()</h2> | |
394 | ||
b9668ba4 AK |
395 | <div class="memitem"> |
396 | <div class="memproto"> | |
397 | <table class="memname"> | |
398 | <tr> | |
0044e680 | 399 | <td class="memname">void yaml_emitter_set_output_file </td> |
b9668ba4 | 400 | <td>(</td> |
059850b5 AK |
401 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
402 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
403 | </tr> |
404 | <tr> | |
405 | <td class="paramkey"></td> | |
406 | <td></td> | |
059850b5 AK |
407 | <td class="paramtype">FILE * </td> |
408 | <td class="paramname"><em>file</em> </td> | |
b9668ba4 AK |
409 | </tr> |
410 | <tr> | |
411 | <td></td> | |
412 | <td>)</td> | |
059850b5 | 413 | <td></td><td></td> |
b9668ba4 AK |
414 | </tr> |
415 | </table> | |
0044e680 | 416 | </div><div class="memdoc"> |
b9668ba4 | 417 | |
0fbeb4dc AK |
418 | <p>Set a file output. </p> |
419 | <p><em>file</em> should be a file object open for writing. The application is responsible for closing the <em>file</em>.</p> | |
0044e680 | 420 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
421 | <table class="params"> |
422 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
423 | <tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>An open file. </td></tr> | |
b9668ba4 | 424 | </table> |
0fbeb4dc | 425 | </dd> |
b9668ba4 AK |
426 | </dl> |
427 | ||
428 | </div> | |
0fbeb4dc | 429 | </div> |
c45550e5 AK |
430 | <a id="gac85a6a212ed7b469fb426a3451d15922"></a> |
431 | <h2 class="memtitle"><span class="permalink"><a href="#gac85a6a212ed7b469fb426a3451d15922">◆ </a></span>yaml_emitter_set_output()</h2> | |
432 | ||
b9668ba4 AK |
433 | <div class="memitem"> |
434 | <div class="memproto"> | |
435 | <table class="memname"> | |
436 | <tr> | |
0044e680 | 437 | <td class="memname">void yaml_emitter_set_output </td> |
b9668ba4 | 438 | <td>(</td> |
059850b5 AK |
439 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
440 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
441 | </tr> |
442 | <tr> | |
443 | <td class="paramkey"></td> | |
444 | <td></td> | |
059850b5 AK |
445 | <td class="paramtype"><a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> * </td> |
446 | <td class="paramname"><em>handler</em>, </td> | |
b9668ba4 AK |
447 | </tr> |
448 | <tr> | |
449 | <td class="paramkey"></td> | |
450 | <td></td> | |
059850b5 AK |
451 | <td class="paramtype">void * </td> |
452 | <td class="paramname"><em>data</em> </td> | |
b9668ba4 AK |
453 | </tr> |
454 | <tr> | |
455 | <td></td> | |
456 | <td>)</td> | |
059850b5 | 457 | <td></td><td></td> |
b9668ba4 AK |
458 | </tr> |
459 | </table> | |
0044e680 | 460 | </div><div class="memdoc"> |
b9668ba4 | 461 | |
0fbeb4dc | 462 | <p>Set a generic output handler. </p> |
0044e680 | 463 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
464 | <table class="params"> |
465 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
466 | <tr><td class="paramdir">[in]</td><td class="paramname">handler</td><td>A write handler. </td></tr> | |
467 | <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Any application data for passing to the write handler. </td></tr> | |
b9668ba4 | 468 | </table> |
0fbeb4dc | 469 | </dd> |
b9668ba4 AK |
470 | </dl> |
471 | ||
472 | </div> | |
0fbeb4dc | 473 | </div> |
c45550e5 AK |
474 | <a id="gabc22888ec8bf942199acbf38f7a0b9bb"></a> |
475 | <h2 class="memtitle"><span class="permalink"><a href="#gabc22888ec8bf942199acbf38f7a0b9bb">◆ </a></span>yaml_emitter_set_encoding()</h2> | |
476 | ||
b9668ba4 AK |
477 | <div class="memitem"> |
478 | <div class="memproto"> | |
479 | <table class="memname"> | |
480 | <tr> | |
0044e680 | 481 | <td class="memname">void yaml_emitter_set_encoding </td> |
b9668ba4 | 482 | <td>(</td> |
059850b5 AK |
483 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
484 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
485 | </tr> |
486 | <tr> | |
487 | <td class="paramkey"></td> | |
488 | <td></td> | |
059850b5 AK |
489 | <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> </td> |
490 | <td class="paramname"><em>encoding</em> </td> | |
b9668ba4 AK |
491 | </tr> |
492 | <tr> | |
493 | <td></td> | |
494 | <td>)</td> | |
059850b5 | 495 | <td></td><td></td> |
b9668ba4 AK |
496 | </tr> |
497 | </table> | |
0044e680 | 498 | </div><div class="memdoc"> |
b9668ba4 | 499 | |
0fbeb4dc | 500 | <p>Set the output encoding. </p> |
0044e680 | 501 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
502 | <table class="params"> |
503 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
504 | <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The output encoding. </td></tr> | |
b9668ba4 | 505 | </table> |
0fbeb4dc | 506 | </dd> |
b9668ba4 AK |
507 | </dl> |
508 | ||
509 | </div> | |
0fbeb4dc | 510 | </div> |
c45550e5 AK |
511 | <a id="ga62713a8130e11d95cbefa95a2eb3ac4b"></a> |
512 | <h2 class="memtitle"><span class="permalink"><a href="#ga62713a8130e11d95cbefa95a2eb3ac4b">◆ </a></span>yaml_emitter_set_canonical()</h2> | |
513 | ||
b9668ba4 AK |
514 | <div class="memitem"> |
515 | <div class="memproto"> | |
516 | <table class="memname"> | |
517 | <tr> | |
0044e680 | 518 | <td class="memname">void yaml_emitter_set_canonical </td> |
b9668ba4 | 519 | <td>(</td> |
059850b5 AK |
520 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
521 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
522 | </tr> |
523 | <tr> | |
524 | <td class="paramkey"></td> | |
525 | <td></td> | |
059850b5 AK |
526 | <td class="paramtype">int </td> |
527 | <td class="paramname"><em>canonical</em> </td> | |
b9668ba4 AK |
528 | </tr> |
529 | <tr> | |
530 | <td></td> | |
531 | <td>)</td> | |
059850b5 | 532 | <td></td><td></td> |
b9668ba4 AK |
533 | </tr> |
534 | </table> | |
0044e680 | 535 | </div><div class="memdoc"> |
b9668ba4 | 536 | |
0fbeb4dc | 537 | <p>Set if the output should be in the "canonical" format as in the YAML specification. </p> |
0044e680 | 538 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
539 | <table class="params"> |
540 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
541 | <tr><td class="paramdir">[in]</td><td class="paramname">canonical</td><td>If the output is canonical. </td></tr> | |
b9668ba4 | 542 | </table> |
0fbeb4dc | 543 | </dd> |
b9668ba4 AK |
544 | </dl> |
545 | ||
546 | </div> | |
0fbeb4dc | 547 | </div> |
c45550e5 AK |
548 | <a id="ga07eca3c344053a9028b4a84291cdf4d7"></a> |
549 | <h2 class="memtitle"><span class="permalink"><a href="#ga07eca3c344053a9028b4a84291cdf4d7">◆ </a></span>yaml_emitter_set_indent()</h2> | |
550 | ||
b9668ba4 AK |
551 | <div class="memitem"> |
552 | <div class="memproto"> | |
553 | <table class="memname"> | |
554 | <tr> | |
0044e680 | 555 | <td class="memname">void yaml_emitter_set_indent </td> |
b9668ba4 | 556 | <td>(</td> |
059850b5 AK |
557 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
558 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
559 | </tr> |
560 | <tr> | |
561 | <td class="paramkey"></td> | |
562 | <td></td> | |
059850b5 AK |
563 | <td class="paramtype">int </td> |
564 | <td class="paramname"><em>indent</em> </td> | |
b9668ba4 AK |
565 | </tr> |
566 | <tr> | |
567 | <td></td> | |
568 | <td>)</td> | |
059850b5 | 569 | <td></td><td></td> |
b9668ba4 AK |
570 | </tr> |
571 | </table> | |
0044e680 | 572 | </div><div class="memdoc"> |
b9668ba4 | 573 | |
0fbeb4dc | 574 | <p>Set the intendation increment. </p> |
0044e680 | 575 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
576 | <table class="params"> |
577 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
578 | <tr><td class="paramdir">[in]</td><td class="paramname">indent</td><td>The indentation increment (1 < . < 10). </td></tr> | |
b9668ba4 | 579 | </table> |
0fbeb4dc | 580 | </dd> |
b9668ba4 AK |
581 | </dl> |
582 | ||
583 | </div> | |
0fbeb4dc | 584 | </div> |
c45550e5 AK |
585 | <a id="gaa91ae0fa8af5ab67e64567e08f4458c2"></a> |
586 | <h2 class="memtitle"><span class="permalink"><a href="#gaa91ae0fa8af5ab67e64567e08f4458c2">◆ </a></span>yaml_emitter_set_width()</h2> | |
587 | ||
b9668ba4 AK |
588 | <div class="memitem"> |
589 | <div class="memproto"> | |
590 | <table class="memname"> | |
591 | <tr> | |
0044e680 | 592 | <td class="memname">void yaml_emitter_set_width </td> |
b9668ba4 | 593 | <td>(</td> |
059850b5 AK |
594 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
595 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
596 | </tr> |
597 | <tr> | |
598 | <td class="paramkey"></td> | |
599 | <td></td> | |
059850b5 AK |
600 | <td class="paramtype">int </td> |
601 | <td class="paramname"><em>width</em> </td> | |
b9668ba4 AK |
602 | </tr> |
603 | <tr> | |
604 | <td></td> | |
605 | <td>)</td> | |
059850b5 | 606 | <td></td><td></td> |
b9668ba4 AK |
607 | </tr> |
608 | </table> | |
0044e680 | 609 | </div><div class="memdoc"> |
b9668ba4 | 610 | |
0fbeb4dc AK |
611 | <p>Set the preferred line width. </p> |
612 | <p><code>-1</code> means unlimited.</p> | |
0044e680 | 613 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
614 | <table class="params"> |
615 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
616 | <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>The preferred line width. </td></tr> | |
b9668ba4 | 617 | </table> |
0fbeb4dc | 618 | </dd> |
b9668ba4 AK |
619 | </dl> |
620 | ||
621 | </div> | |
0fbeb4dc | 622 | </div> |
c45550e5 AK |
623 | <a id="gaa59e7dcf24cb9b614c32af6c3e949fc3"></a> |
624 | <h2 class="memtitle"><span class="permalink"><a href="#gaa59e7dcf24cb9b614c32af6c3e949fc3">◆ </a></span>yaml_emitter_set_unicode()</h2> | |
625 | ||
b9668ba4 AK |
626 | <div class="memitem"> |
627 | <div class="memproto"> | |
628 | <table class="memname"> | |
629 | <tr> | |
0044e680 | 630 | <td class="memname">void yaml_emitter_set_unicode </td> |
b9668ba4 | 631 | <td>(</td> |
059850b5 AK |
632 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
633 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
634 | </tr> |
635 | <tr> | |
636 | <td class="paramkey"></td> | |
637 | <td></td> | |
059850b5 AK |
638 | <td class="paramtype">int </td> |
639 | <td class="paramname"><em>unicode</em> </td> | |
b9668ba4 AK |
640 | </tr> |
641 | <tr> | |
642 | <td></td> | |
643 | <td>)</td> | |
059850b5 | 644 | <td></td><td></td> |
b9668ba4 AK |
645 | </tr> |
646 | </table> | |
0044e680 | 647 | </div><div class="memdoc"> |
b9668ba4 | 648 | |
0fbeb4dc | 649 | <p>Set if unescaped non-ASCII characters are allowed. </p> |
0044e680 | 650 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
651 | <table class="params"> |
652 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
653 | <tr><td class="paramdir">[in]</td><td class="paramname">unicode</td><td>If unescaped Unicode characters are allowed. </td></tr> | |
b9668ba4 | 654 | </table> |
0fbeb4dc | 655 | </dd> |
b9668ba4 AK |
656 | </dl> |
657 | ||
658 | </div> | |
0fbeb4dc | 659 | </div> |
c45550e5 AK |
660 | <a id="ga04b5494f0b8244eec359579c31d5e20c"></a> |
661 | <h2 class="memtitle"><span class="permalink"><a href="#ga04b5494f0b8244eec359579c31d5e20c">◆ </a></span>yaml_emitter_set_break()</h2> | |
662 | ||
b9668ba4 AK |
663 | <div class="memitem"> |
664 | <div class="memproto"> | |
665 | <table class="memname"> | |
666 | <tr> | |
0044e680 | 667 | <td class="memname">void yaml_emitter_set_break </td> |
b9668ba4 | 668 | <td>(</td> |
059850b5 AK |
669 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
670 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
671 | </tr> |
672 | <tr> | |
673 | <td class="paramkey"></td> | |
674 | <td></td> | |
059850b5 AK |
675 | <td class="paramtype"><a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> </td> |
676 | <td class="paramname"><em>line_break</em> </td> | |
b9668ba4 AK |
677 | </tr> |
678 | <tr> | |
679 | <td></td> | |
680 | <td>)</td> | |
059850b5 | 681 | <td></td><td></td> |
b9668ba4 AK |
682 | </tr> |
683 | </table> | |
0044e680 | 684 | </div><div class="memdoc"> |
b9668ba4 | 685 | |
0fbeb4dc | 686 | <p>Set the preferred line break. </p> |
0044e680 | 687 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
688 | <table class="params"> |
689 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
690 | <tr><td class="paramdir">[in]</td><td class="paramname">line_break</td><td>The preferred line break. </td></tr> | |
b9668ba4 | 691 | </table> |
0fbeb4dc | 692 | </dd> |
b9668ba4 AK |
693 | </dl> |
694 | ||
695 | </div> | |
0fbeb4dc | 696 | </div> |
c45550e5 AK |
697 | <a id="ga4d6c0f8e712797e2660e69479fdae433"></a> |
698 | <h2 class="memtitle"><span class="permalink"><a href="#ga4d6c0f8e712797e2660e69479fdae433">◆ </a></span>yaml_emitter_emit()</h2> | |
699 | ||
b9668ba4 AK |
700 | <div class="memitem"> |
701 | <div class="memproto"> | |
702 | <table class="memname"> | |
703 | <tr> | |
0044e680 | 704 | <td class="memname">int yaml_emitter_emit </td> |
b9668ba4 | 705 | <td>(</td> |
059850b5 AK |
706 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
707 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
708 | </tr> |
709 | <tr> | |
710 | <td class="paramkey"></td> | |
711 | <td></td> | |
059850b5 AK |
712 | <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> |
713 | <td class="paramname"><em>event</em> </td> | |
b9668ba4 AK |
714 | </tr> |
715 | <tr> | |
716 | <td></td> | |
717 | <td>)</td> | |
059850b5 | 718 | <td></td><td></td> |
b9668ba4 AK |
719 | </tr> |
720 | </table> | |
0044e680 | 721 | </div><div class="memdoc"> |
b9668ba4 | 722 | |
0fbeb4dc | 723 | <p>Emit an event. </p> |
0044e680 AK |
724 | <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> |
725 | <dl class="params"><dt>Parameters</dt><dd> | |
059850b5 AK |
726 | <table class="params"> |
727 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
728 | <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object.</td></tr> | |
b9668ba4 | 729 | </table> |
0fbeb4dc | 730 | </dd> |
b9668ba4 | 731 | </dl> |
0044e680 | 732 | <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
733 | |
734 | </div> | |
0fbeb4dc | 735 | </div> |
c45550e5 AK |
736 | <a id="gae323c34e378040106f24c7b5ab834b16"></a> |
737 | <h2 class="memtitle"><span class="permalink"><a href="#gae323c34e378040106f24c7b5ab834b16">◆ </a></span>yaml_emitter_open()</h2> | |
738 | ||
b9668ba4 AK |
739 | <div class="memitem"> |
740 | <div class="memproto"> | |
741 | <table class="memname"> | |
742 | <tr> | |
0044e680 | 743 | <td class="memname">int yaml_emitter_open </td> |
b9668ba4 | 744 | <td>(</td> |
059850b5 AK |
745 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
746 | <td class="paramname"><em>emitter</em></td><td>)</td> | |
5c706339 | 747 | <td></td> |
b9668ba4 AK |
748 | </tr> |
749 | </table> | |
0044e680 | 750 | </div><div class="memdoc"> |
b9668ba4 | 751 | |
0fbeb4dc | 752 | <p>Start a YAML stream. </p> |
0044e680 AK |
753 | <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> |
754 | <dl class="params"><dt>Parameters</dt><dd> | |
059850b5 AK |
755 | <table class="params"> |
756 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr> | |
b9668ba4 | 757 | </table> |
0fbeb4dc | 758 | </dd> |
b9668ba4 | 759 | </dl> |
0044e680 | 760 | <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
761 | |
762 | </div> | |
0fbeb4dc | 763 | </div> |
c45550e5 AK |
764 | <a id="gaa91442864679280985df14b2d96b8c42"></a> |
765 | <h2 class="memtitle"><span class="permalink"><a href="#gaa91442864679280985df14b2d96b8c42">◆ </a></span>yaml_emitter_close()</h2> | |
766 | ||
b9668ba4 AK |
767 | <div class="memitem"> |
768 | <div class="memproto"> | |
769 | <table class="memname"> | |
770 | <tr> | |
0044e680 | 771 | <td class="memname">int yaml_emitter_close </td> |
b9668ba4 | 772 | <td>(</td> |
059850b5 AK |
773 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
774 | <td class="paramname"><em>emitter</em></td><td>)</td> | |
5c706339 | 775 | <td></td> |
b9668ba4 AK |
776 | </tr> |
777 | </table> | |
0044e680 | 778 | </div><div class="memdoc"> |
b9668ba4 | 779 | |
0fbeb4dc | 780 | <p>Finish a YAML stream. </p> |
0044e680 AK |
781 | <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> |
782 | <dl class="params"><dt>Parameters</dt><dd> | |
059850b5 AK |
783 | <table class="params"> |
784 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr> | |
b9668ba4 | 785 | </table> |
0fbeb4dc | 786 | </dd> |
b9668ba4 | 787 | </dl> |
0044e680 | 788 | <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
789 | |
790 | </div> | |
0fbeb4dc | 791 | </div> |
c45550e5 AK |
792 | <a id="ga5f0306abe9bff373b5bc339913b3769c"></a> |
793 | <h2 class="memtitle"><span class="permalink"><a href="#ga5f0306abe9bff373b5bc339913b3769c">◆ </a></span>yaml_emitter_dump()</h2> | |
794 | ||
b9668ba4 AK |
795 | <div class="memitem"> |
796 | <div class="memproto"> | |
797 | <table class="memname"> | |
798 | <tr> | |
0044e680 | 799 | <td class="memname">int yaml_emitter_dump </td> |
b9668ba4 | 800 | <td>(</td> |
059850b5 AK |
801 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
802 | <td class="paramname"><em>emitter</em>, </td> | |
b9668ba4 AK |
803 | </tr> |
804 | <tr> | |
805 | <td class="paramkey"></td> | |
806 | <td></td> | |
059850b5 AK |
807 | <td class="paramtype"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a> * </td> |
808 | <td class="paramname"><em>document</em> </td> | |
b9668ba4 AK |
809 | </tr> |
810 | <tr> | |
811 | <td></td> | |
812 | <td>)</td> | |
059850b5 | 813 | <td></td><td></td> |
b9668ba4 AK |
814 | </tr> |
815 | </table> | |
0044e680 | 816 | </div><div class="memdoc"> |
b9668ba4 | 817 | |
0fbeb4dc | 818 | <p>Emit a YAML document. </p> |
c45550e5 | 819 | <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 destroys its content after it is emitted. The document object is destroyed even if the function fails.</p> |
0044e680 | 820 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
821 | <table class="params"> |
822 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object. </td></tr> | |
823 | <tr><td class="paramdir">[in,out]</td><td class="paramname">document</td><td>A document object.</td></tr> | |
b9668ba4 | 824 | </table> |
0fbeb4dc | 825 | </dd> |
b9668ba4 | 826 | </dl> |
0044e680 | 827 | <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
828 | |
829 | </div> | |
0fbeb4dc | 830 | </div> |
c45550e5 AK |
831 | <a id="gacaf24456e2bf85bc5654cbd7d828055f"></a> |
832 | <h2 class="memtitle"><span class="permalink"><a href="#gacaf24456e2bf85bc5654cbd7d828055f">◆ </a></span>yaml_emitter_flush()</h2> | |
833 | ||
b9668ba4 AK |
834 | <div class="memitem"> |
835 | <div class="memproto"> | |
836 | <table class="memname"> | |
837 | <tr> | |
0044e680 | 838 | <td class="memname">int yaml_emitter_flush </td> |
b9668ba4 | 839 | <td>(</td> |
059850b5 AK |
840 | <td class="paramtype"><a class="el" href="group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b">yaml_emitter_t</a> * </td> |
841 | <td class="paramname"><em>emitter</em></td><td>)</td> | |
5c706339 | 842 | <td></td> |
b9668ba4 AK |
843 | </tr> |
844 | </table> | |
0044e680 | 845 | </div><div class="memdoc"> |
b9668ba4 | 846 | |
0fbeb4dc | 847 | <p>Flush the accumulated characters to the output. </p> |
0044e680 | 848 | <dl class="params"><dt>Parameters</dt><dd> |
059850b5 AK |
849 | <table class="params"> |
850 | <tr><td class="paramdir">[in,out]</td><td class="paramname">emitter</td><td>An emitter object.</td></tr> | |
b9668ba4 | 851 | </table> |
0fbeb4dc | 852 | </dd> |
b9668ba4 | 853 | </dl> |
0044e680 | 854 | <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> |
b9668ba4 AK |
855 | |
856 | </div> | |
5c706339 | 857 | </div> |
059850b5 | 858 | </div><!-- contents --> |
0044e680 | 859 | <!-- start footer part --> |
059850b5 | 860 | <hr class="footer"/><address class="footer"><small> |
c45550e5 | 861 | Generated by  <a href="http://www.doxygen.org/index.html"> |
059850b5 | 862 | <img class="footer" src="doxygen.png" alt="doxygen"/> |
c45550e5 | 863 | </a> 1.8.14 |
059850b5 | 864 | </small></address> |
b9668ba4 AK |
865 | </body> |
866 | </html> |