2015-12-05 16:50:27 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2023-12-27 21:45:35 +00:00
< meta name = "generator" content = "Doxygen 1.8.14" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2015-12-05 16:50:27 +00:00
< title > yaml: Emitter Definitions< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
2023-12-27 21:45:35 +00:00
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
2015-12-05 16:50:27 +00:00
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
2023-12-27 21:45:35 +00:00
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
2015-12-05 16:50:27 +00:00
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
2023-12-27 21:45:35 +00:00
< td id = "projectalign" style = "padding-left: 0.5em;" >
2015-12-05 16:50:27 +00:00
< div id = "projectname" > yaml
2023-12-27 21:45:35 +00:00
  < span id = "projectnumber" > 0.2.5< / span >
2015-12-05 16:50:27 +00:00
< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2023-12-27 21:45:35 +00:00
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */< / script >
< div id = "main-nav" > < / div >
< / div > <!-- top -->
2015-12-05 16:50:27 +00:00
< div class = "header" >
< div class = "summary" >
< a href = "#nested-classes" > Data Structures< / a > |
< a href = "#typedef-members" > Typedefs< / a > |
< a href = "#enum-members" > Enumerations< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > Emitter Definitions< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< table class = "memberdecls" >
2023-12-27 21:45:35 +00:00
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "nested-classes" > < / a >
2015-12-05 16:50:27 +00:00
Data Structures< / h2 > < / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< 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 >
< tr class = "separator:" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "typedef-members" > < / a >
2015-12-05 16:50:27 +00:00
Typedefs< / h2 > < / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
< 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 >
< tr class = "separator:ga1669659aacbe631ad406c78fce1f5379" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga0889461fa3efe8eee881aef48a4ba6b2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The emitter states. < a href = "#ga0889461fa3efe8eee881aef48a4ba6b2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga0889461fa3efe8eee881aef48a4ba6b2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:ga4086f2799cbee6055a032d55488cb280" > < td class = "memItemLeft" align = "right" valign = "top" > < a id = "ga4086f2799cbee6055a032d55488cb280" > < / a >
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 >
< tr class = "separator:ga4086f2799cbee6055a032d55488cb280" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga4ce3e054f0016c49d9e8c36d359e710b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > The emitter structure. < a href = "#ga4ce3e054f0016c49d9e8c36d359e710b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga4ce3e054f0016c49d9e8c36d359e710b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "enum-members" > < / a >
2015-12-05 16:50:27 +00:00
Enumerations< / h2 > < / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721aa013a33dab710fe9a30ba014af27b81d" > YAML_EMIT_STREAM_START_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721ab1ae25188f02581a137f66c4b6e084ae" > YAML_EMIT_FIRST_DOCUMENT_START_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a678d8c3146f0b2c84e0fc537a9b1109f" > YAML_EMIT_DOCUMENT_START_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a5ce3ed6155496a6fbd7384e310c58bec" > YAML_EMIT_DOCUMENT_CONTENT_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3" > YAML_EMIT_DOCUMENT_END_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a5a36fc535f3a5720fbb86712959e5654" > YAML_EMIT_FLOW_SEQUENCE_FIRST_ITEM_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721aded45f1dee80027d7b9c6ce061c08767" > YAML_EMIT_FLOW_SEQUENCE_ITEM_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721ab811f3d642dacc7c413af2c32356f894" > YAML_EMIT_FLOW_MAPPING_FIRST_KEY_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721ababf835ee5cd4c6de2231e2a49e40626" > YAML_EMIT_FLOW_MAPPING_KEY_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721aa6f687a6b57e727f0e7b7a2687ad7383" > YAML_EMIT_FLOW_MAPPING_SIMPLE_VALUE_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721acb6dbcb535248b8fde779aeedc957b2e" > YAML_EMIT_FLOW_MAPPING_VALUE_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a68af7c090c6d0187788e390341f0cc4d" > YAML_EMIT_BLOCK_SEQUENCE_FIRST_ITEM_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a8197c180c3cefee7b67304e17b52c5ff" > YAML_EMIT_BLOCK_SEQUENCE_ITEM_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721aee36d46c1facecfd73fab73e3343226e" > YAML_EMIT_BLOCK_MAPPING_FIRST_KEY_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a58495cae63b8c3d7c389b1281baeec05" > YAML_EMIT_BLOCK_MAPPING_KEY_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a4aa3c6bf2f2d976c47289c741d7a8704" > YAML_EMIT_BLOCK_MAPPING_SIMPLE_VALUE_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a7e0f7fac64fc64bb2bc9fe2ec93ca564" > YAML_EMIT_BLOCK_MAPPING_VALUE_STATE< / a > ,
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
    < a class = "el" href = "group__emitter.html#gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0" > YAML_EMIT_END_STATE< / a >
2023-12-27 21:45:35 +00:00
< br / >
2015-12-05 16:50:27 +00:00
}< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
< tr class = "separator:ga387b79da11c3941e43a56947263aa721" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
2015-12-05 16:50:27 +00:00
Functions< / h2 > < / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
< tr class = "memdesc:ga83649205374285802fc27aa293ecd111" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Initialize an emitter. < a href = "#ga83649205374285802fc27aa293ecd111" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga83649205374285802fc27aa293ecd111" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gad705212f3a5150e3f00075fd90bc8c3d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Destroy an emitter. < a href = "#gad705212f3a5150e3f00075fd90bc8c3d" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gad705212f3a5150e3f00075fd90bc8c3d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga62725c0f616f634588374d1a4c0ed35a" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set a string output. < a href = "#ga62725c0f616f634588374d1a4c0ed35a" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga62725c0f616f634588374d1a4c0ed35a" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gaf7610c61b303bde9c701024c10ece024" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set a file output. < a href = "#gaf7610c61b303bde9c701024c10ece024" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaf7610c61b303bde9c701024c10ece024" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gac85a6a212ed7b469fb426a3451d15922" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set a generic output handler. < a href = "#gac85a6a212ed7b469fb426a3451d15922" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gac85a6a212ed7b469fb426a3451d15922" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gabc22888ec8bf942199acbf38f7a0b9bb" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the output encoding. < a href = "#gabc22888ec8bf942199acbf38f7a0b9bb" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gabc22888ec8bf942199acbf38f7a0b9bb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< 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 >
< tr class = "separator:ga62713a8130e11d95cbefa95a2eb3ac4b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga07eca3c344053a9028b4a84291cdf4d7" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the indentation increment. < a href = "#ga07eca3c344053a9028b4a84291cdf4d7" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga07eca3c344053a9028b4a84291cdf4d7" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gaa91ae0fa8af5ab67e64567e08f4458c2" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the preferred line width. < a href = "#gaa91ae0fa8af5ab67e64567e08f4458c2" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaa91ae0fa8af5ab67e64567e08f4458c2" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< 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 >
< tr class = "separator:gaa59e7dcf24cb9b614c32af6c3e949fc3" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga04b5494f0b8244eec359579c31d5e20c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Set the preferred line break. < a href = "#ga04b5494f0b8244eec359579c31d5e20c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga04b5494f0b8244eec359579c31d5e20c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga4d6c0f8e712797e2660e69479fdae433" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Emit an event. < a href = "#ga4d6c0f8e712797e2660e69479fdae433" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga4d6c0f8e712797e2660e69479fdae433" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gae323c34e378040106f24c7b5ab834b16" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Start a YAML stream. < a href = "#gae323c34e378040106f24c7b5ab834b16" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gae323c34e378040106f24c7b5ab834b16" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:gaa91442864679280985df14b2d96b8c42" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Finish a YAML stream. < a href = "#gaa91442864679280985df14b2d96b8c42" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaa91442864679280985df14b2d96b8c42" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< tr class = "memdesc:ga5f0306abe9bff373b5bc339913b3769c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Emit a YAML document. < a href = "#ga5f0306abe9bff373b5bc339913b3769c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga5f0306abe9bff373b5bc339913b3769c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< 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 >
< 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 >
< tr class = "separator:gacaf24456e2bf85bc5654cbd7d828055f" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2015-12-05 16:50:27 +00:00
< / table >
2023-12-27 21:45:35 +00:00
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Detailed Description< / h2 >
< h2 class = "groupheader" > Typedef Documentation< / h2 >
< a id = "ga1669659aacbe631ad406c78fce1f5379" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga1669659aacbe631ad406c78fce1f5379" > ◆ < / a > < / span > yaml_write_handler_t< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > typedef int yaml_write_handler_t(void *data, unsigned char *buffer, size_t size)< / td >
2015-12-05 16:50:27 +00:00
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > The prototype of a write handler. < / p >
< 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 >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > buffer< / td > < td > The buffer with bytes to be written. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > size< / td > < td > The size of the buffer.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga0889461fa3efe8eee881aef48a4ba6b2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga0889461fa3efe8eee881aef48a4ba6b2" > ◆ < / a > < / span > yaml_emitter_state_t< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< 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 >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > The emitter states. < / p >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga4ce3e054f0016c49d9e8c36d359e710b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga4ce3e054f0016c49d9e8c36d359e710b" > ◆ < / a > < / span > yaml_emitter_t< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< 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 >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > The emitter structure. < / p >
< p > All members are internal. Manage the structure using the < code > yaml_emitter_< / code > family of functions. < / p >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< h2 class = "groupheader" > Enumeration Type Documentation< / h2 >
< a id = "ga387b79da11c3941e43a56947263aa721" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga387b79da11c3941e43a56947263aa721" > ◆ < / a > < / span > yaml_emitter_state_e< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > enum < a class = "el" href = "group__emitter.html#ga387b79da11c3941e43a56947263aa721" > yaml_emitter_state_e< / a > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > The emitter states. < / p >
2023-12-27 21:45:35 +00:00
< table class = "fieldtable" >
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< tr > < td class = "fieldname" > < a id = "gga387b79da11c3941e43a56947263aa721a100cad4538be033202da4bb85f8443d3" > < / a > YAML_EMIT_DOCUMENT_END_STATE  < / td > < td class = "fielddoc" > < p > Expect DOCUMENT-END. < / p >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< 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 >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
2023-12-27 21:45:35 +00:00
< tr > < td class = "fieldname" > < a id = "gga387b79da11c3941e43a56947263aa721a2a0232912eaf4eeb06594ee6157dfbc0" > < / a > YAML_EMIT_END_STATE  < / td > < td class = "fielddoc" > < p > Expect nothing. < / p >
2015-12-05 16:50:27 +00:00
< / td > < / tr >
< / table >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< h2 class = "groupheader" > Function Documentation< / h2 >
< a id = "ga83649205374285802fc27aa293ecd111" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga83649205374285802fc27aa293ecd111" > ◆ < / a > < / span > yaml_emitter_initialize()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > int yaml_emitter_initialize < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Initialize an emitter. < / p >
2023-12-27 21:45:35 +00:00
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [out]< / td > < td class = "paramname" > emitter< / td > < td > An empty parser object.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > < code > 1< / code > if the function succeeded, < code > 0< / code > on error. < / dd > < / dl >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gad705212f3a5150e3f00075fd90bc8c3d" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gad705212f3a5150e3f00075fd90bc8c3d" > ◆ < / a > < / span > yaml_emitter_delete()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_delete < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Destroy an emitter. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga62725c0f616f634588374d1a4c0ed35a" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga62725c0f616f634588374d1a4c0ed35a" > ◆ < / a > < / span > yaml_emitter_set_output_string()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_output_string < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > unsigned char *  < / td >
< td class = "paramname" > < em > output< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t  < / td >
< td class = "paramname" > < em > size< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > size_t *  < / td >
< td class = "paramname" > < em > size_written< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set a string output. < / p >
< 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 >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > output< / td > < td > An output buffer. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > size< / td > < td > The buffer size. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > size_written< / td > < td > The pointer to save the number of written bytes. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gaf7610c61b303bde9c701024c10ece024" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaf7610c61b303bde9c701024c10ece024" > ◆ < / a > < / span > yaml_emitter_set_output_file()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_output_file < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > FILE *  < / td >
< td class = "paramname" > < em > file< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set a file output. < / p >
< p > < em > file< / em > should be a file object open for writing. The application is responsible for closing the < em > file< / em > .< / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > file< / td > < td > An open file. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gac85a6a212ed7b469fb426a3451d15922" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gac85a6a212ed7b469fb426a3451d15922" > ◆ < / a > < / span > yaml_emitter_set_output()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_output < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga1669659aacbe631ad406c78fce1f5379" > yaml_write_handler_t< / a > *  < / td >
< td class = "paramname" > < em > handler< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > data< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set a generic output handler. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > handler< / td > < td > A write handler. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > data< / td > < td > Any application data for passing to the write handler. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gabc22888ec8bf942199acbf38f7a0b9bb" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gabc22888ec8bf942199acbf38f7a0b9bb" > ◆ < / a > < / span > yaml_emitter_set_encoding()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_encoding < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6" > yaml_encoding_t< / a >   < / td >
< td class = "paramname" > < em > encoding< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set the output encoding. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > encoding< / td > < td > The output encoding. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga62713a8130e11d95cbefa95a2eb3ac4b" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga62713a8130e11d95cbefa95a2eb3ac4b" > ◆ < / a > < / span > yaml_emitter_set_canonical()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_canonical < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > canonical< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set if the output should be in the "canonical" format as in the YAML specification. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > canonical< / td > < td > If the output is canonical. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga07eca3c344053a9028b4a84291cdf4d7" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga07eca3c344053a9028b4a84291cdf4d7" > ◆ < / a > < / span > yaml_emitter_set_indent()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_indent < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > indent< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
2023-12-27 21:45:35 +00:00
< p > Set the indentation increment. < / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > indent< / td > < td > The indentation increment (1 < . < 10). < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gaa91ae0fa8af5ab67e64567e08f4458c2" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaa91ae0fa8af5ab67e64567e08f4458c2" > ◆ < / a > < / span > yaml_emitter_set_width()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_width < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > width< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set the preferred line width. < / p >
< p > < code > -1< / code > means unlimited.< / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > width< / td > < td > The preferred line width. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gaa59e7dcf24cb9b614c32af6c3e949fc3" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaa59e7dcf24cb9b614c32af6c3e949fc3" > ◆ < / a > < / span > yaml_emitter_set_unicode()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_unicode < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > int  < / td >
< td class = "paramname" > < em > unicode< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set if unescaped non-ASCII characters are allowed. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > unicode< / td > < td > If unescaped Unicode characters are allowed. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga04b5494f0b8244eec359579c31d5e20c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga04b5494f0b8244eec359579c31d5e20c" > ◆ < / a > < / span > yaml_emitter_set_break()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > void yaml_emitter_set_break < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "group__basic.html#ga64d1365e1acd4deeab50d6b48e39cb6d" > yaml_break_t< / a >   < / td >
< td class = "paramname" > < em > line_break< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Set the preferred line break. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in]< / td > < td class = "paramname" > line_break< / td > < td > The preferred line break. < / td > < / tr >
< / table >
< / dd >
< / dl >
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga4d6c0f8e712797e2660e69479fdae433" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga4d6c0f8e712797e2660e69479fdae433" > ◆ < / a > < / span > yaml_emitter_emit()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > int yaml_emitter_emit < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "group__events.html#ga3b392d9716c4920cabefdd29e78dd542" > yaml_event_t< / a > *  < / td >
< td class = "paramname" > < em > event< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Emit an event. < / p >
2023-12-27 21:45:35 +00:00
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > event< / td > < td > An event object.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > < code > 1< / code > if the function succeeded, < code > 0< / code > on error. < / dd > < / dl >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gae323c34e378040106f24c7b5ab834b16" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gae323c34e378040106f24c7b5ab834b16" > ◆ < / a > < / span > yaml_emitter_open()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > int yaml_emitter_open < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Start a YAML stream. < / p >
2023-12-27 21:45:35 +00:00
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > < code > 1< / code > if the function succeeded, < code > 0< / code > on error. < / dd > < / dl >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gaa91442864679280985df14b2d96b8c42" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gaa91442864679280985df14b2d96b8c42" > ◆ < / a > < / span > yaml_emitter_close()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > int yaml_emitter_close < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Finish a YAML stream. < / p >
2023-12-27 21:45:35 +00:00
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > < code > 1< / code > if the function succeeded, < code > 0< / code > on error. < / dd > < / dl >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "ga5f0306abe9bff373b5bc339913b3769c" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#ga5f0306abe9bff373b5bc339913b3769c" > ◆ < / a > < / span > yaml_emitter_dump()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > int yaml_emitter_dump < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > < a class = "el" href = "group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479" > yaml_document_t< / a > *  < / td >
< td class = "paramname" > < em > document< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Emit a YAML document. < / p >
2023-12-27 21:45:35 +00:00
< 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 >
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object. < / td > < / tr >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > document< / td > < td > A document object.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > < code > 1< / code > if the function succeeded, < code > 0< / code > on error. < / dd > < / dl >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
2023-12-27 21:45:35 +00:00
< a id = "gacaf24456e2bf85bc5654cbd7d828055f" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#gacaf24456e2bf85bc5654cbd7d828055f" > ◆ < / a > < / span > yaml_emitter_flush()< / h2 >
2015-12-05 16:50:27 +00:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2023-12-27 21:45:35 +00:00
< td class = "memname" > int yaml_emitter_flush < / td >
2015-12-05 16:50:27 +00:00
< td > (< / td >
< td class = "paramtype" > < a class = "el" href = "group__emitter.html#ga4ce3e054f0016c49d9e8c36d359e710b" > yaml_emitter_t< / a > *  < / td >
< td class = "paramname" > < em > emitter< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
2023-12-27 21:45:35 +00:00
< / div > < div class = "memdoc" >
2015-12-05 16:50:27 +00:00
< p > Flush the accumulated characters to the output. < / p >
2023-12-27 21:45:35 +00:00
< dl class = "params" > < dt > Parameters< / dt > < dd >
2015-12-05 16:50:27 +00:00
< table class = "params" >
< tr > < td class = "paramdir" > [in,out]< / td > < td class = "paramname" > emitter< / td > < td > An emitter object.< / td > < / tr >
< / table >
< / dd >
< / dl >
2023-12-27 21:45:35 +00:00
< dl class = "section return" > < dt > Returns< / dt > < dd > < code > 1< / code > if the function succeeded, < code > 0< / code > on error. < / dd > < / dl >
2015-12-05 16:50:27 +00:00
< / div >
< / div >
< / div > <!-- contents -->
2023-12-27 21:45:35 +00:00
<!-- start footer part -->
2015-12-05 16:50:27 +00:00
< hr class = "footer" / > < address class = "footer" > < small >
2023-12-27 21:45:35 +00:00
Generated by   < a href = "http://www.doxygen.org/index.html" >
2015-12-05 16:50:27 +00:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
2023-12-27 21:45:35 +00:00
< / a > 1.8.14
2015-12-05 16:50:27 +00:00
< / small > < / address >
< / body >
< / html >