1247738Sbapt<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2247738Sbapt<html xmlns="http://www.w3.org/1999/xhtml"> 3247738Sbapt<head> 4247738Sbapt<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5247738Sbapt<title>yaml: Emitter Definitions</title> 6247738Sbapt<link href="tabs.css" rel="stylesheet" type="text/css"/> 7247738Sbapt<link href="doxygen.css" rel="stylesheet" type="text/css"/> 8247738Sbapt</head> 9247738Sbapt<body> 10247738Sbapt<!-- Generated by Doxygen 1.7.1 --> 11247738Sbapt<div class="navigation" id="top"> 12247738Sbapt <div class="tabs"> 13247738Sbapt <ul class="tablist"> 14247738Sbapt <li><a href="index.html"><span>Main Page</span></a></li> 15247738Sbapt <li><a href="modules.html"><span>Modules</span></a></li> 16247738Sbapt <li><a href="annotated.html"><span>Data Structures</span></a></li> 17247738Sbapt <li><a href="files.html"><span>Files</span></a></li> 18247738Sbapt </ul> 19247738Sbapt </div> 20247738Sbapt</div> 21247738Sbapt<div class="header"> 22247738Sbapt <div class="summary"> 23247738Sbapt<a href="#nested-classes">Data Structures</a> | 24247738Sbapt<a href="#typedef-members">Typedefs</a> | 25247738Sbapt<a href="#enum-members">Enumerations</a> | 26247738Sbapt<a href="#func-members">Functions</a> </div> 27247738Sbapt <div class="headertitle"> 28247738Sbapt<h1>Emitter Definitions</h1> </div> 29247738Sbapt</div> 30247738Sbapt<div class="contents"> 31247738Sbapt<table class="memberdecls"> 32247738Sbapt<tr><td colspan="2"><h2><a name="nested-classes"></a> 33247738SbaptData Structures</h2></td></tr> 34247738Sbapt<tr><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> 35247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="structyaml__emitter__s.html#_details">More...</a><br/></td></tr> 36247738Sbapt<tr><td colspan="2"><h2><a name="typedef-members"></a> 37247738SbaptTypedefs</h2></td></tr> 38247738Sbapt<tr><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> 39247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The prototype of a write handler. <a href="#ga1669659aacbe631ad406c78fce1f5379"></a><br/></td></tr> 40247738Sbapt<tr><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> 41247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The emitter states. <a href="#ga0889461fa3efe8eee881aef48a4ba6b2"></a><br/></td></tr> 42247738Sbapt<tr><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> 43247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The emitter structure. <a href="#ga4ce3e054f0016c49d9e8c36d359e710b"></a><br/></td></tr> 44247738Sbapt<tr><td colspan="2"><h2><a name="enum-members"></a> 45247738SbaptEnumerations</h2></td></tr> 46247738Sbapt<tr><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/> 47247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d">YAML_EMIT_STREAM_START_STATE</a>, 48247738Sbapt<br/> 49247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae">YAML_EMIT_FIRST_DOCUMENT_START_STATE</a>, 50247738Sbapt<br/> 51247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f">YAML_EMIT_DOCUMENT_START_STATE</a>, 52247738Sbapt<br/> 53247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec">YAML_EMIT_DOCUMENT_CONTENT_STATE</a>, 54247738Sbapt<br/> 55247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3">YAML_EMIT_DOCUMENT_END_STATE</a>, 56247738Sbapt<br/> 57247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654">YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</a>, 58247738Sbapt<br/> 59247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767">YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</a>, 60247738Sbapt<br/> 61247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894">YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</a>, 62247738Sbapt<br/> 63247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626">YAML_EMIT_FLOW_MAPPING_KEY_STATE</a>, 64247738Sbapt<br/> 65247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383">YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</a>, 66247738Sbapt<br/> 67247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e">YAML_EMIT_FLOW_MAPPING_VALUE_STATE</a>, 68247738Sbapt<br/> 69247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d">YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</a>, 70247738Sbapt<br/> 71247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff">YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</a>, 72247738Sbapt<br/> 73247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e">YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</a>, 74247738Sbapt<br/> 75247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05">YAML_EMIT_BLOCK_MAPPING_KEY_STATE</a>, 76247738Sbapt<br/> 77247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704">YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</a>, 78247738Sbapt<br/> 79247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564">YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</a>, 80247738Sbapt<br/> 81247738Sbapt <a class="el" href="group__emitter.html#gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0">YAML_EMIT_END_STATE</a> 82247738Sbapt<br/> 83247738Sbapt }</td></tr> 84247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>The emitter states. </p> 85247738Sbapt <a href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">More...</a><br/></td></tr> 86247738Sbapt<tr><td colspan="2"><h2><a name="func-members"></a> 87247738SbaptFunctions</h2></td></tr> 88247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter)</td></tr> 89247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize an emitter. <a href="#ga83649205374285802fc27aa293ecd111"></a><br/></td></tr> 90247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter)</td></tr> 91247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy an emitter. <a href="#gad705212f3a5150e3f00075fd90bc8c3d"></a><br/></td></tr> 92247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, unsigned char *output, size_t size, size_t *size_written)</td></tr> 93247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string output. <a href="#ga62725c0f616f634588374d1a4c0ed35a"></a><br/></td></tr> 94247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, FILE *file)</td></tr> 95247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a file output. <a href="#gaf7610c61b303bde9c701024c10ece024"></a><br/></td></tr> 96247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, <a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> *handler, void *data)</td></tr> 97247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a generic output handler. <a href="#gac85a6a212ed7b469fb426a3451d15922"></a><br/></td></tr> 98247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr> 99247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the output encoding. <a href="#gabc22888ec8bf942199acbf38f7a0b9bb"></a><br/></td></tr> 100247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, int canonical)</td></tr> 101247738Sbapt<tr><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"></a><br/></td></tr> 102247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, int indent)</td></tr> 103247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the intendation increment. <a href="#ga07eca3c344053a9028b4a84291cdf4d7"></a><br/></td></tr> 104247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, int width)</td></tr> 105247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line width. <a href="#gaa91ae0fa8af5ab67e64567e08f4458c2"></a><br/></td></tr> 106247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, int unicode)</td></tr> 107247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set if unescaped non-ASCII characters are allowed. <a href="#gaa59e7dcf24cb9b614c32af6c3e949fc3"></a><br/></td></tr> 108247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, <a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> line_break)</td></tr> 109247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the preferred line break. <a href="#ga04b5494f0b8244eec359579c31d5e20c"></a><br/></td></tr> 110247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, <a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event)</td></tr> 111247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Emit an event. <a href="#ga4d6c0f8e712797e2660e69479fdae433"></a><br/></td></tr> 112247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter)</td></tr> 113247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Start a YAML stream. <a href="#gae323c34e378040106f24c7b5ab834b16"></a><br/></td></tr> 114247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter)</td></tr> 115247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Finish a YAML stream. <a href="#gaa91442864679280985df14b2d96b8c42"></a><br/></td></tr> 116247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter, <a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document)</td></tr> 117247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Emit a YAML document. <a href="#ga5f0306abe9bff373b5bc339913b3769c"></a><br/></td></tr> 118247738Sbapt<tr><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="structyaml__emitter__s.html">yaml_emitter_t</a> *emitter)</td></tr> 119247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Flush the accumulated characters to the output. <a href="#gacaf24456e2bf85bc5654cbd7d828055f"></a><br/></td></tr> 120247738Sbapt</table> 121247738Sbapt<hr/><h2>Typedef Documentation</h2> 122247738Sbapt<a class="anchor" id="ga1669659aacbe631ad406c78fce1f5379"></a><!-- doxytag: member="yaml.h::yaml_write_handler_t" ref="ga1669659aacbe631ad406c78fce1f5379" args="(void *data, unsigned char *buffer, size_t size)" --> 123247738Sbapt<div class="memitem"> 124247738Sbapt<div class="memproto"> 125247738Sbapt <table class="memname"> 126247738Sbapt <tr> 127247738Sbapt <td class="memname">typedef int <a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a>(void *data, unsigned char *buffer, size_t size)</td> 128247738Sbapt </tr> 129247738Sbapt </table> 130247738Sbapt</div> 131247738Sbapt<div class="memdoc"> 132247738Sbapt 133247738Sbapt<p>The prototype of a write handler. </p> 134247738Sbapt<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> 135247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 136247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 137247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>data</em> </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> 138247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>buffer</em> </td><td>The buffer with bytes to be written. </td></tr> 139247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>The size of the buffer.</td></tr> 140247738Sbapt </table> 141247738Sbapt </dd> 142247738Sbapt</dl> 143247738Sbapt<dl class="return"><dt><b>Returns:</b></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> 144247738Sbapt 145247738Sbapt</div> 146247738Sbapt</div> 147247738Sbapt<a class="anchor" id="ga0889461fa3efe8eee881aef48a4ba6b2"></a><!-- doxytag: member="yaml.h::yaml_emitter_state_t" ref="ga0889461fa3efe8eee881aef48a4ba6b2" args="" --> 148247738Sbapt<div class="memitem"> 149247738Sbapt<div class="memproto"> 150247738Sbapt <table class="memname"> 151247738Sbapt <tr> 152247738Sbapt <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> 153247738Sbapt </tr> 154247738Sbapt </table> 155247738Sbapt</div> 156247738Sbapt<div class="memdoc"> 157247738Sbapt 158247738Sbapt<p>The emitter states. </p> 159247738Sbapt 160247738Sbapt</div> 161247738Sbapt</div> 162247738Sbapt<a class="anchor" id="ga4ce3e054f0016c49d9e8c36d359e710b"></a><!-- doxytag: member="yaml.h::yaml_emitter_t" ref="ga4ce3e054f0016c49d9e8c36d359e710b" args="" --> 163247738Sbapt<div class="memitem"> 164247738Sbapt<div class="memproto"> 165247738Sbapt <table class="memname"> 166247738Sbapt <tr> 167247738Sbapt <td class="memname">typedef struct <a class="el" href="structyaml__emitter__s.html">yaml_emitter_s</a> <a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a></td> 168247738Sbapt </tr> 169247738Sbapt </table> 170247738Sbapt</div> 171247738Sbapt<div class="memdoc"> 172247738Sbapt 173247738Sbapt<p>The emitter structure. </p> 174247738Sbapt<p>All members are internal. Manage the structure using the <code>yaml_emitter_</code> family of functions. </p> 175247738Sbapt 176247738Sbapt</div> 177247738Sbapt</div> 178247738Sbapt<hr/><h2>Enumeration Type Documentation</h2> 179247738Sbapt<a class="anchor" id="ga387b79da11c3941e43a56947263aa721"></a><!-- doxytag: member="yaml.h::yaml_emitter_state_e" ref="ga387b79da11c3941e43a56947263aa721" args="" --> 180247738Sbapt<div class="memitem"> 181247738Sbapt<div class="memproto"> 182247738Sbapt <table class="memname"> 183247738Sbapt <tr> 184247738Sbapt <td class="memname">enum <a class="el" href="group__emitter.html#ga387b79da11c3941e43a56947263aa721">yaml_emitter_state_e</a></td> 185247738Sbapt </tr> 186247738Sbapt </table> 187247738Sbapt</div> 188247738Sbapt<div class="memdoc"> 189247738Sbapt 190247738Sbapt<p>The emitter states. </p> 191247738Sbapt<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 192247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d"></a><!-- doxytag: member="YAML_EMIT_STREAM_START_STATE" ref="gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d" args="" -->YAML_EMIT_STREAM_START_STATE</em> </td><td> 193247738Sbapt<p>Expect STREAM-START. </p> 194247738Sbapt</td></tr> 195247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae"></a><!-- doxytag: member="YAML_EMIT_FIRST_DOCUMENT_START_STATE" ref="gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae" args="" -->YAML_EMIT_FIRST_DOCUMENT_START_STATE</em> </td><td> 196247738Sbapt<p>Expect the first DOCUMENT-START or STREAM-END. </p> 197247738Sbapt</td></tr> 198247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f"></a><!-- doxytag: member="YAML_EMIT_DOCUMENT_START_STATE" ref="gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f" args="" -->YAML_EMIT_DOCUMENT_START_STATE</em> </td><td> 199247738Sbapt<p>Expect DOCUMENT-START or STREAM-END. </p> 200247738Sbapt</td></tr> 201247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec"></a><!-- doxytag: member="YAML_EMIT_DOCUMENT_CONTENT_STATE" ref="gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec" args="" -->YAML_EMIT_DOCUMENT_CONTENT_STATE</em> </td><td> 202247738Sbapt<p>Expect the content of a document. </p> 203247738Sbapt</td></tr> 204247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3"></a><!-- doxytag: member="YAML_EMIT_DOCUMENT_END_STATE" ref="gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3" args="" -->YAML_EMIT_DOCUMENT_END_STATE</em> </td><td> 205247738Sbapt<p>Expect DOCUMENT-END. </p> 206247738Sbapt</td></tr> 207247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654"></a><!-- doxytag: member="YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE" ref="gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654" args="" -->YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE</em> </td><td> 208247738Sbapt<p>Expect the first item of a flow sequence. </p> 209247738Sbapt</td></tr> 210247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767"></a><!-- doxytag: member="YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE" ref="gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767" args="" -->YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE</em> </td><td> 211247738Sbapt<p>Expect an item of a flow sequence. </p> 212247738Sbapt</td></tr> 213247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894"></a><!-- doxytag: member="YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE" ref="gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894" args="" -->YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE</em> </td><td> 214247738Sbapt<p>Expect the first key of a flow mapping. </p> 215247738Sbapt</td></tr> 216247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626"></a><!-- doxytag: member="YAML_EMIT_FLOW_MAPPING_KEY_STATE" ref="gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626" args="" -->YAML_EMIT_FLOW_MAPPING_KEY_STATE</em> </td><td> 217247738Sbapt<p>Expect a key of a flow mapping. </p> 218247738Sbapt</td></tr> 219247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383"></a><!-- doxytag: member="YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE" ref="gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383" args="" -->YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE</em> </td><td> 220247738Sbapt<p>Expect a value for a simple key of a flow mapping. </p> 221247738Sbapt</td></tr> 222247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e"></a><!-- doxytag: member="YAML_EMIT_FLOW_MAPPING_VALUE_STATE" ref="gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e" args="" -->YAML_EMIT_FLOW_MAPPING_VALUE_STATE</em> </td><td> 223247738Sbapt<p>Expect a value of a flow mapping. </p> 224247738Sbapt</td></tr> 225247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d"></a><!-- doxytag: member="YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE" ref="gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d" args="" -->YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE</em> </td><td> 226247738Sbapt<p>Expect the first item of a block sequence. </p> 227247738Sbapt</td></tr> 228247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff"></a><!-- doxytag: member="YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE" ref="gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff" args="" -->YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE</em> </td><td> 229247738Sbapt<p>Expect an item of a block sequence. </p> 230247738Sbapt</td></tr> 231247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e"></a><!-- doxytag: member="YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE" ref="gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e" args="" -->YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE</em> </td><td> 232247738Sbapt<p>Expect the first key of a block mapping. </p> 233247738Sbapt</td></tr> 234247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05"></a><!-- doxytag: member="YAML_EMIT_BLOCK_MAPPING_KEY_STATE" ref="gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05" args="" -->YAML_EMIT_BLOCK_MAPPING_KEY_STATE</em> </td><td> 235247738Sbapt<p>Expect the key of a block mapping. </p> 236247738Sbapt</td></tr> 237247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704"></a><!-- doxytag: member="YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE" ref="gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704" args="" -->YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE</em> </td><td> 238247738Sbapt<p>Expect a value for a simple key of a block mapping. </p> 239247738Sbapt</td></tr> 240247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564"></a><!-- doxytag: member="YAML_EMIT_BLOCK_MAPPING_VALUE_STATE" ref="gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564" args="" -->YAML_EMIT_BLOCK_MAPPING_VALUE_STATE</em> </td><td> 241247738Sbapt<p>Expect a value of a block mapping. </p> 242247738Sbapt</td></tr> 243247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0"></a><!-- doxytag: member="YAML_EMIT_END_STATE" ref="gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0" args="" -->YAML_EMIT_END_STATE</em> </td><td> 244247738Sbapt<p>Expect nothing. </p> 245247738Sbapt</td></tr> 246247738Sbapt</table> 247247738Sbapt</dd> 248247738Sbapt</dl> 249247738Sbapt 250247738Sbapt</div> 251247738Sbapt</div> 252247738Sbapt<hr/><h2>Function Documentation</h2> 253247738Sbapt<a class="anchor" id="ga83649205374285802fc27aa293ecd111"></a><!-- doxytag: member="yaml.h::yaml_emitter_initialize" ref="ga83649205374285802fc27aa293ecd111" args="(yaml_emitter_t *emitter)" --> 254247738Sbapt<div class="memitem"> 255247738Sbapt<div class="memproto"> 256247738Sbapt <table class="memname"> 257247738Sbapt <tr> 258247738Sbapt <td class="memname">int yaml_emitter_initialize </td> 259247738Sbapt <td>(</td> 260247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 261247738Sbapt <td class="paramname"> <em>emitter</em></td> 262247738Sbapt <td> ) </td> 263247738Sbapt <td></td> 264247738Sbapt </tr> 265247738Sbapt </table> 266247738Sbapt</div> 267247738Sbapt<div class="memdoc"> 268247738Sbapt 269247738Sbapt<p>Initialize an emitter. </p> 270247738Sbapt<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> 271247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 272247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 273247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An empty parser object.</td></tr> 274247738Sbapt </table> 275247738Sbapt </dd> 276247738Sbapt</dl> 277247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 278247738Sbapt 279247738Sbapt</div> 280247738Sbapt</div> 281247738Sbapt<a class="anchor" id="gad705212f3a5150e3f00075fd90bc8c3d"></a><!-- doxytag: member="yaml.h::yaml_emitter_delete" ref="gad705212f3a5150e3f00075fd90bc8c3d" args="(yaml_emitter_t *emitter)" --> 282247738Sbapt<div class="memitem"> 283247738Sbapt<div class="memproto"> 284247738Sbapt <table class="memname"> 285247738Sbapt <tr> 286247738Sbapt <td class="memname">void yaml_emitter_delete </td> 287247738Sbapt <td>(</td> 288247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 289247738Sbapt <td class="paramname"> <em>emitter</em></td> 290247738Sbapt <td> ) </td> 291247738Sbapt <td></td> 292247738Sbapt </tr> 293247738Sbapt </table> 294247738Sbapt</div> 295247738Sbapt<div class="memdoc"> 296247738Sbapt 297247738Sbapt<p>Destroy an emitter. </p> 298247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 299247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 300247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 301247738Sbapt </table> 302247738Sbapt </dd> 303247738Sbapt</dl> 304247738Sbapt 305247738Sbapt</div> 306247738Sbapt</div> 307247738Sbapt<a class="anchor" id="ga62725c0f616f634588374d1a4c0ed35a"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_output_string" ref="ga62725c0f616f634588374d1a4c0ed35a" args="(yaml_emitter_t *emitter, unsigned char *output, size_t size, size_t *size_written)" --> 308247738Sbapt<div class="memitem"> 309247738Sbapt<div class="memproto"> 310247738Sbapt <table class="memname"> 311247738Sbapt <tr> 312247738Sbapt <td class="memname">void yaml_emitter_set_output_string </td> 313247738Sbapt <td>(</td> 314247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 315247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 316247738Sbapt </tr> 317247738Sbapt <tr> 318247738Sbapt <td class="paramkey"></td> 319247738Sbapt <td></td> 320247738Sbapt <td class="paramtype">unsigned char * </td> 321247738Sbapt <td class="paramname"> <em>output</em>, </td> 322247738Sbapt </tr> 323247738Sbapt <tr> 324247738Sbapt <td class="paramkey"></td> 325247738Sbapt <td></td> 326247738Sbapt <td class="paramtype">size_t </td> 327247738Sbapt <td class="paramname"> <em>size</em>, </td> 328247738Sbapt </tr> 329247738Sbapt <tr> 330247738Sbapt <td class="paramkey"></td> 331247738Sbapt <td></td> 332247738Sbapt <td class="paramtype">size_t * </td> 333247738Sbapt <td class="paramname"> <em>size_written</em></td><td> </td> 334247738Sbapt </tr> 335247738Sbapt <tr> 336247738Sbapt <td></td> 337247738Sbapt <td>)</td> 338247738Sbapt <td></td><td></td><td></td> 339247738Sbapt </tr> 340247738Sbapt </table> 341247738Sbapt</div> 342247738Sbapt<div class="memdoc"> 343247738Sbapt 344247738Sbapt<p>Set a string output. </p> 345247738Sbapt<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> 346247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 347247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 348247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 349247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>output</em> </td><td>An output buffer. </td></tr> 350247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size</em> </td><td>The buffer size. </td></tr> 351247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>size_written</em> </td><td>The pointer to save the number of written bytes. </td></tr> 352247738Sbapt </table> 353247738Sbapt </dd> 354247738Sbapt</dl> 355247738Sbapt 356247738Sbapt</div> 357247738Sbapt</div> 358247738Sbapt<a class="anchor" id="gaf7610c61b303bde9c701024c10ece024"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_output_file" ref="gaf7610c61b303bde9c701024c10ece024" args="(yaml_emitter_t *emitter, FILE *file)" --> 359247738Sbapt<div class="memitem"> 360247738Sbapt<div class="memproto"> 361247738Sbapt <table class="memname"> 362247738Sbapt <tr> 363247738Sbapt <td class="memname">void yaml_emitter_set_output_file </td> 364247738Sbapt <td>(</td> 365247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 366247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 367247738Sbapt </tr> 368247738Sbapt <tr> 369247738Sbapt <td class="paramkey"></td> 370247738Sbapt <td></td> 371247738Sbapt <td class="paramtype">FILE * </td> 372247738Sbapt <td class="paramname"> <em>file</em></td><td> </td> 373247738Sbapt </tr> 374247738Sbapt <tr> 375247738Sbapt <td></td> 376247738Sbapt <td>)</td> 377247738Sbapt <td></td><td></td><td></td> 378247738Sbapt </tr> 379247738Sbapt </table> 380247738Sbapt</div> 381247738Sbapt<div class="memdoc"> 382247738Sbapt 383247738Sbapt<p>Set a file output. </p> 384247738Sbapt<p><em>file</em> should be a file object open for writing. The application is responsible for closing the <em>file</em>.</p> 385247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 386247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 387247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 388247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>file</em> </td><td>An open file. </td></tr> 389247738Sbapt </table> 390247738Sbapt </dd> 391247738Sbapt</dl> 392247738Sbapt 393247738Sbapt</div> 394247738Sbapt</div> 395247738Sbapt<a class="anchor" id="gac85a6a212ed7b469fb426a3451d15922"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_output" ref="gac85a6a212ed7b469fb426a3451d15922" args="(yaml_emitter_t *emitter, yaml_write_handler_t *handler, void *data)" --> 396247738Sbapt<div class="memitem"> 397247738Sbapt<div class="memproto"> 398247738Sbapt <table class="memname"> 399247738Sbapt <tr> 400247738Sbapt <td class="memname">void yaml_emitter_set_output </td> 401247738Sbapt <td>(</td> 402247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 403247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 404247738Sbapt </tr> 405247738Sbapt <tr> 406247738Sbapt <td class="paramkey"></td> 407247738Sbapt <td></td> 408247738Sbapt <td class="paramtype"><a class="el" href="group__emitter.html#ga1669659aacbe631ad406c78fce1f5379">yaml_write_handler_t</a> * </td> 409247738Sbapt <td class="paramname"> <em>handler</em>, </td> 410247738Sbapt </tr> 411247738Sbapt <tr> 412247738Sbapt <td class="paramkey"></td> 413247738Sbapt <td></td> 414247738Sbapt <td class="paramtype">void * </td> 415247738Sbapt <td class="paramname"> <em>data</em></td><td> </td> 416247738Sbapt </tr> 417247738Sbapt <tr> 418247738Sbapt <td></td> 419247738Sbapt <td>)</td> 420247738Sbapt <td></td><td></td><td></td> 421247738Sbapt </tr> 422247738Sbapt </table> 423247738Sbapt</div> 424247738Sbapt<div class="memdoc"> 425247738Sbapt 426247738Sbapt<p>Set a generic output handler. </p> 427247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 428247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 429247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 430247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>handler</em> </td><td>A write handler. </td></tr> 431247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>data</em> </td><td>Any application data for passing to the write handler. </td></tr> 432247738Sbapt </table> 433247738Sbapt </dd> 434247738Sbapt</dl> 435247738Sbapt 436247738Sbapt</div> 437247738Sbapt</div> 438247738Sbapt<a class="anchor" id="gabc22888ec8bf942199acbf38f7a0b9bb"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_encoding" ref="gabc22888ec8bf942199acbf38f7a0b9bb" args="(yaml_emitter_t *emitter, yaml_encoding_t encoding)" --> 439247738Sbapt<div class="memitem"> 440247738Sbapt<div class="memproto"> 441247738Sbapt <table class="memname"> 442247738Sbapt <tr> 443247738Sbapt <td class="memname">void yaml_emitter_set_encoding </td> 444247738Sbapt <td>(</td> 445247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 446247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 447247738Sbapt </tr> 448247738Sbapt <tr> 449247738Sbapt <td class="paramkey"></td> 450247738Sbapt <td></td> 451247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> </td> 452247738Sbapt <td class="paramname"> <em>encoding</em></td><td> </td> 453247738Sbapt </tr> 454247738Sbapt <tr> 455247738Sbapt <td></td> 456247738Sbapt <td>)</td> 457247738Sbapt <td></td><td></td><td></td> 458247738Sbapt </tr> 459247738Sbapt </table> 460247738Sbapt</div> 461247738Sbapt<div class="memdoc"> 462247738Sbapt 463247738Sbapt<p>Set the output encoding. </p> 464247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 465247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 466247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 467247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>encoding</em> </td><td>The output encoding. </td></tr> 468247738Sbapt </table> 469247738Sbapt </dd> 470247738Sbapt</dl> 471247738Sbapt 472247738Sbapt</div> 473247738Sbapt</div> 474247738Sbapt<a class="anchor" id="ga62713a8130e11d95cbefa95a2eb3ac4b"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_canonical" ref="ga62713a8130e11d95cbefa95a2eb3ac4b" args="(yaml_emitter_t *emitter, int canonical)" --> 475247738Sbapt<div class="memitem"> 476247738Sbapt<div class="memproto"> 477247738Sbapt <table class="memname"> 478247738Sbapt <tr> 479247738Sbapt <td class="memname">void yaml_emitter_set_canonical </td> 480247738Sbapt <td>(</td> 481247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 482247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 483247738Sbapt </tr> 484247738Sbapt <tr> 485247738Sbapt <td class="paramkey"></td> 486247738Sbapt <td></td> 487247738Sbapt <td class="paramtype">int </td> 488247738Sbapt <td class="paramname"> <em>canonical</em></td><td> </td> 489247738Sbapt </tr> 490247738Sbapt <tr> 491247738Sbapt <td></td> 492247738Sbapt <td>)</td> 493247738Sbapt <td></td><td></td><td></td> 494247738Sbapt </tr> 495247738Sbapt </table> 496247738Sbapt</div> 497247738Sbapt<div class="memdoc"> 498247738Sbapt 499247738Sbapt<p>Set if the output should be in the "canonical" format as in the YAML specification. </p> 500247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 501247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 502247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 503247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>canonical</em> </td><td>If the output is canonical. </td></tr> 504247738Sbapt </table> 505247738Sbapt </dd> 506247738Sbapt</dl> 507247738Sbapt 508247738Sbapt</div> 509247738Sbapt</div> 510247738Sbapt<a class="anchor" id="ga07eca3c344053a9028b4a84291cdf4d7"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_indent" ref="ga07eca3c344053a9028b4a84291cdf4d7" args="(yaml_emitter_t *emitter, int indent)" --> 511247738Sbapt<div class="memitem"> 512247738Sbapt<div class="memproto"> 513247738Sbapt <table class="memname"> 514247738Sbapt <tr> 515247738Sbapt <td class="memname">void yaml_emitter_set_indent </td> 516247738Sbapt <td>(</td> 517247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 518247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 519247738Sbapt </tr> 520247738Sbapt <tr> 521247738Sbapt <td class="paramkey"></td> 522247738Sbapt <td></td> 523247738Sbapt <td class="paramtype">int </td> 524247738Sbapt <td class="paramname"> <em>indent</em></td><td> </td> 525247738Sbapt </tr> 526247738Sbapt <tr> 527247738Sbapt <td></td> 528247738Sbapt <td>)</td> 529247738Sbapt <td></td><td></td><td></td> 530247738Sbapt </tr> 531247738Sbapt </table> 532247738Sbapt</div> 533247738Sbapt<div class="memdoc"> 534247738Sbapt 535247738Sbapt<p>Set the intendation increment. </p> 536247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 537247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 538247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 539247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>indent</em> </td><td>The indentation increment (1 < . < 10). </td></tr> 540247738Sbapt </table> 541247738Sbapt </dd> 542247738Sbapt</dl> 543247738Sbapt 544247738Sbapt</div> 545247738Sbapt</div> 546247738Sbapt<a class="anchor" id="gaa91ae0fa8af5ab67e64567e08f4458c2"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_width" ref="gaa91ae0fa8af5ab67e64567e08f4458c2" args="(yaml_emitter_t *emitter, int width)" --> 547247738Sbapt<div class="memitem"> 548247738Sbapt<div class="memproto"> 549247738Sbapt <table class="memname"> 550247738Sbapt <tr> 551247738Sbapt <td class="memname">void yaml_emitter_set_width </td> 552247738Sbapt <td>(</td> 553247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 554247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 555247738Sbapt </tr> 556247738Sbapt <tr> 557247738Sbapt <td class="paramkey"></td> 558247738Sbapt <td></td> 559247738Sbapt <td class="paramtype">int </td> 560247738Sbapt <td class="paramname"> <em>width</em></td><td> </td> 561247738Sbapt </tr> 562247738Sbapt <tr> 563247738Sbapt <td></td> 564247738Sbapt <td>)</td> 565247738Sbapt <td></td><td></td><td></td> 566247738Sbapt </tr> 567247738Sbapt </table> 568247738Sbapt</div> 569247738Sbapt<div class="memdoc"> 570247738Sbapt 571247738Sbapt<p>Set the preferred line width. </p> 572247738Sbapt<p><code>-1</code> means unlimited.</p> 573247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 574247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 575247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 576247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>width</em> </td><td>The preferred line width. </td></tr> 577247738Sbapt </table> 578247738Sbapt </dd> 579247738Sbapt</dl> 580247738Sbapt 581247738Sbapt</div> 582247738Sbapt</div> 583247738Sbapt<a class="anchor" id="gaa59e7dcf24cb9b614c32af6c3e949fc3"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_unicode" ref="gaa59e7dcf24cb9b614c32af6c3e949fc3" args="(yaml_emitter_t *emitter, int unicode)" --> 584247738Sbapt<div class="memitem"> 585247738Sbapt<div class="memproto"> 586247738Sbapt <table class="memname"> 587247738Sbapt <tr> 588247738Sbapt <td class="memname">void yaml_emitter_set_unicode </td> 589247738Sbapt <td>(</td> 590247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 591247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 592247738Sbapt </tr> 593247738Sbapt <tr> 594247738Sbapt <td class="paramkey"></td> 595247738Sbapt <td></td> 596247738Sbapt <td class="paramtype">int </td> 597247738Sbapt <td class="paramname"> <em>unicode</em></td><td> </td> 598247738Sbapt </tr> 599247738Sbapt <tr> 600247738Sbapt <td></td> 601247738Sbapt <td>)</td> 602247738Sbapt <td></td><td></td><td></td> 603247738Sbapt </tr> 604247738Sbapt </table> 605247738Sbapt</div> 606247738Sbapt<div class="memdoc"> 607247738Sbapt 608247738Sbapt<p>Set if unescaped non-ASCII characters are allowed. </p> 609247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 610247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 611247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 612247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>unicode</em> </td><td>If unescaped Unicode characters are allowed. </td></tr> 613247738Sbapt </table> 614247738Sbapt </dd> 615247738Sbapt</dl> 616247738Sbapt 617247738Sbapt</div> 618247738Sbapt</div> 619247738Sbapt<a class="anchor" id="ga04b5494f0b8244eec359579c31d5e20c"></a><!-- doxytag: member="yaml.h::yaml_emitter_set_break" ref="ga04b5494f0b8244eec359579c31d5e20c" args="(yaml_emitter_t *emitter, yaml_break_t line_break)" --> 620247738Sbapt<div class="memitem"> 621247738Sbapt<div class="memproto"> 622247738Sbapt <table class="memname"> 623247738Sbapt <tr> 624247738Sbapt <td class="memname">void yaml_emitter_set_break </td> 625247738Sbapt <td>(</td> 626247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 627247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 628247738Sbapt </tr> 629247738Sbapt <tr> 630247738Sbapt <td class="paramkey"></td> 631247738Sbapt <td></td> 632247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d">yaml_break_t</a> </td> 633247738Sbapt <td class="paramname"> <em>line_break</em></td><td> </td> 634247738Sbapt </tr> 635247738Sbapt <tr> 636247738Sbapt <td></td> 637247738Sbapt <td>)</td> 638247738Sbapt <td></td><td></td><td></td> 639247738Sbapt </tr> 640247738Sbapt </table> 641247738Sbapt</div> 642247738Sbapt<div class="memdoc"> 643247738Sbapt 644247738Sbapt<p>Set the preferred line break. </p> 645247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 646247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 647247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 648247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>line_break</em> </td><td>The preferred line break. </td></tr> 649247738Sbapt </table> 650247738Sbapt </dd> 651247738Sbapt</dl> 652247738Sbapt 653247738Sbapt</div> 654247738Sbapt</div> 655247738Sbapt<a class="anchor" id="ga4d6c0f8e712797e2660e69479fdae433"></a><!-- doxytag: member="yaml.h::yaml_emitter_emit" ref="ga4d6c0f8e712797e2660e69479fdae433" args="(yaml_emitter_t *emitter, yaml_event_t *event)" --> 656247738Sbapt<div class="memitem"> 657247738Sbapt<div class="memproto"> 658247738Sbapt <table class="memname"> 659247738Sbapt <tr> 660247738Sbapt <td class="memname">int yaml_emitter_emit </td> 661247738Sbapt <td>(</td> 662247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 663247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 664247738Sbapt </tr> 665247738Sbapt <tr> 666247738Sbapt <td class="paramkey"></td> 667247738Sbapt <td></td> 668247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 669247738Sbapt <td class="paramname"> <em>event</em></td><td> </td> 670247738Sbapt </tr> 671247738Sbapt <tr> 672247738Sbapt <td></td> 673247738Sbapt <td>)</td> 674247738Sbapt <td></td><td></td><td></td> 675247738Sbapt </tr> 676247738Sbapt </table> 677247738Sbapt</div> 678247738Sbapt<div class="memdoc"> 679247738Sbapt 680247738Sbapt<p>Emit an event. </p> 681247738Sbapt<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> 682247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 683247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 684247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 685247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>event</em> </td><td>An event object.</td></tr> 686247738Sbapt </table> 687247738Sbapt </dd> 688247738Sbapt</dl> 689247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 690247738Sbapt 691247738Sbapt</div> 692247738Sbapt</div> 693247738Sbapt<a class="anchor" id="gae323c34e378040106f24c7b5ab834b16"></a><!-- doxytag: member="yaml.h::yaml_emitter_open" ref="gae323c34e378040106f24c7b5ab834b16" args="(yaml_emitter_t *emitter)" --> 694247738Sbapt<div class="memitem"> 695247738Sbapt<div class="memproto"> 696247738Sbapt <table class="memname"> 697247738Sbapt <tr> 698247738Sbapt <td class="memname">int yaml_emitter_open </td> 699247738Sbapt <td>(</td> 700247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 701247738Sbapt <td class="paramname"> <em>emitter</em></td> 702247738Sbapt <td> ) </td> 703247738Sbapt <td></td> 704247738Sbapt </tr> 705247738Sbapt </table> 706247738Sbapt</div> 707247738Sbapt<div class="memdoc"> 708247738Sbapt 709247738Sbapt<p>Start a YAML stream. </p> 710247738Sbapt<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> 711247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 712247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 713247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object.</td></tr> 714247738Sbapt </table> 715247738Sbapt </dd> 716247738Sbapt</dl> 717247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 718247738Sbapt 719247738Sbapt</div> 720247738Sbapt</div> 721247738Sbapt<a class="anchor" id="gaa91442864679280985df14b2d96b8c42"></a><!-- doxytag: member="yaml.h::yaml_emitter_close" ref="gaa91442864679280985df14b2d96b8c42" args="(yaml_emitter_t *emitter)" --> 722247738Sbapt<div class="memitem"> 723247738Sbapt<div class="memproto"> 724247738Sbapt <table class="memname"> 725247738Sbapt <tr> 726247738Sbapt <td class="memname">int yaml_emitter_close </td> 727247738Sbapt <td>(</td> 728247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 729247738Sbapt <td class="paramname"> <em>emitter</em></td> 730247738Sbapt <td> ) </td> 731247738Sbapt <td></td> 732247738Sbapt </tr> 733247738Sbapt </table> 734247738Sbapt</div> 735247738Sbapt<div class="memdoc"> 736247738Sbapt 737247738Sbapt<p>Finish a YAML stream. </p> 738247738Sbapt<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> 739247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 740247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 741247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object.</td></tr> 742247738Sbapt </table> 743247738Sbapt </dd> 744247738Sbapt</dl> 745247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 746247738Sbapt 747247738Sbapt</div> 748247738Sbapt</div> 749247738Sbapt<a class="anchor" id="ga5f0306abe9bff373b5bc339913b3769c"></a><!-- doxytag: member="yaml.h::yaml_emitter_dump" ref="ga5f0306abe9bff373b5bc339913b3769c" args="(yaml_emitter_t *emitter, yaml_document_t *document)" --> 750247738Sbapt<div class="memitem"> 751247738Sbapt<div class="memproto"> 752247738Sbapt <table class="memname"> 753247738Sbapt <tr> 754247738Sbapt <td class="memname">int yaml_emitter_dump </td> 755247738Sbapt <td>(</td> 756247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 757247738Sbapt <td class="paramname"> <em>emitter</em>, </td> 758247738Sbapt </tr> 759247738Sbapt <tr> 760247738Sbapt <td class="paramkey"></td> 761247738Sbapt <td></td> 762247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 763247738Sbapt <td class="paramname"> <em>document</em></td><td> </td> 764247738Sbapt </tr> 765247738Sbapt <tr> 766247738Sbapt <td></td> 767247738Sbapt <td>)</td> 768247738Sbapt <td></td><td></td><td></td> 769247738Sbapt </tr> 770247738Sbapt </table> 771247738Sbapt</div> 772247738Sbapt<div class="memdoc"> 773247738Sbapt 774247738Sbapt<p>Emit a YAML document. </p> 775247738Sbapt<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> 776247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 777247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 778247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object. </td></tr> 779247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object.</td></tr> 780247738Sbapt </table> 781247738Sbapt </dd> 782247738Sbapt</dl> 783247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 784247738Sbapt 785247738Sbapt</div> 786247738Sbapt</div> 787247738Sbapt<a class="anchor" id="gacaf24456e2bf85bc5654cbd7d828055f"></a><!-- doxytag: member="yaml.h::yaml_emitter_flush" ref="gacaf24456e2bf85bc5654cbd7d828055f" args="(yaml_emitter_t *emitter)" --> 788247738Sbapt<div class="memitem"> 789247738Sbapt<div class="memproto"> 790247738Sbapt <table class="memname"> 791247738Sbapt <tr> 792247738Sbapt <td class="memname">int yaml_emitter_flush </td> 793247738Sbapt <td>(</td> 794247738Sbapt <td class="paramtype"><a class="el" href="structyaml__emitter__s.html">yaml_emitter_t</a> * </td> 795247738Sbapt <td class="paramname"> <em>emitter</em></td> 796247738Sbapt <td> ) </td> 797247738Sbapt <td></td> 798247738Sbapt </tr> 799247738Sbapt </table> 800247738Sbapt</div> 801247738Sbapt<div class="memdoc"> 802247738Sbapt 803247738Sbapt<p>Flush the accumulated characters to the output. </p> 804247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 805247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 806247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>emitter</em> </td><td>An emitter object.</td></tr> 807247738Sbapt </table> 808247738Sbapt </dd> 809247738Sbapt</dl> 810247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 811247738Sbapt 812247738Sbapt</div> 813247738Sbapt</div> 814247738Sbapt</div> 815247738Sbapt<hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by 816247738Sbapt<a href="http://www.doxygen.org/index.html"> 817247738Sbapt<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> 818247738Sbapt</body> 819247738Sbapt</html> 820
