📁 File Manager Pro
v10.0.3 | PHP: 8.1.34
Server: Apache
2026-06-22 08:35:37
📂
/ (Root)
/
opt
/
alt
/
ruby20
/
share
/
doc
/
ruby
/
capi
/
html
/
d1
/
ddf
📍 /opt/alt/ruby20/share/doc/ruby/capi/html/d1/ddf
🔄 Refresh
✏️
Editing: group__events.html
Read Only
<!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"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Ruby: Events</title> <link href="../../tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="../../jquery.js"></script> <script type="text/javascript" src="../../dynsections.js"></script> <link href="../../doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Ruby  <span id="projectnumber">2.0.0p648(2015-12-16revision53162)</span> </div> </td> </tr> </tbody> </table> </div> <!-- 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 --> <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">Events</div> </div> </div><!--header--> <div class="contents"> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d72/structyaml__event__s.html">yaml_event_s</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The event structure. <a href="../../d2/d72/structyaml__event__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> Typedefs</h2></td></tr> <tr class="memitem:ga8934661be36bd7c9d17a8af69eff89a1"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="../../d1/ddf/group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td></tr> <tr class="memdesc:ga8934661be36bd7c9d17a8af69eff89a1"><td class="mdescLeft"> </td><td class="mdescRight">Event types. <a href="#ga8934661be36bd7c9d17a8af69eff89a1">More...</a><br /></td></tr> <tr class="separator:ga8934661be36bd7c9d17a8af69eff89a1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3b392d9716c4920cabefdd29e78dd542"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="../../d2/d72/structyaml__event__s.html">yaml_event_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td></tr> <tr class="memdesc:ga3b392d9716c4920cabefdd29e78dd542"><td class="mdescLeft"> </td><td class="mdescRight">The event structure. <a href="#ga3b392d9716c4920cabefdd29e78dd542">More...</a><br /></td></tr> <tr class="separator:ga3b392d9716c4920cabefdd29e78dd542"><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> Enumerations</h2></td></tr> <tr class="memitem:ga454fccebae859c188fe3e7fa3299577c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> { <br />   <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac">YAML_NO_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465">YAML_STREAM_START_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b">YAML_STREAM_END_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3">YAML_DOCUMENT_START_EVENT</a>, <br />   <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f">YAML_DOCUMENT_END_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7">YAML_ALIAS_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713">YAML_SCALAR_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093">YAML_SEQUENCE_START_EVENT</a>, <br />   <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898">YAML_SEQUENCE_END_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8">YAML_MAPPING_START_EVENT</a>, <a class="el" href="../../d1/ddf/group__events.html#gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30">YAML_MAPPING_END_EVENT</a> <br /> }</td></tr> <tr class="memdesc:ga454fccebae859c188fe3e7fa3299577c"><td class="mdescLeft"> </td><td class="mdescRight">Event types. <a href="../../d1/ddf/group__events.html#ga454fccebae859c188fe3e7fa3299577c">More...</a><br /></td></tr> <tr class="separator:ga454fccebae859c188fe3e7fa3299577c"><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> Functions</h2></td></tr> <tr class="memitem:gad88ee2f0df5c2664506e837e7314e4f1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#gad88ee2f0df5c2664506e837e7314e4f1">yaml_stream_start_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="../../d0/df6/group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr> <tr class="memdesc:gad88ee2f0df5c2664506e837e7314e4f1"><td class="mdescLeft"> </td><td class="mdescRight">Create the STREAM-START event. <a href="#gad88ee2f0df5c2664506e837e7314e4f1">More...</a><br /></td></tr> <tr class="separator:gad88ee2f0df5c2664506e837e7314e4f1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga87c423095c6ad061d3e5c9b805286c0b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga87c423095c6ad061d3e5c9b805286c0b">yaml_stream_end_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr> <tr class="memdesc:ga87c423095c6ad061d3e5c9b805286c0b"><td class="mdescLeft"> </td><td class="mdescRight">Create the STREAM-END event. <a href="#ga87c423095c6ad061d3e5c9b805286c0b">More...</a><br /></td></tr> <tr class="separator:ga87c423095c6ad061d3e5c9b805286c0b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab3fd5335a5405439762ad64bc5c2dce4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#gab3fd5335a5405439762ad64bc5c2dce4">yaml_document_start_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="../../d0/df6/group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *version_directive, <a class="el" href="../../d0/df6/group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="../../d0/df6/group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_end, int implicit)</td></tr> <tr class="memdesc:gab3fd5335a5405439762ad64bc5c2dce4"><td class="mdescLeft"> </td><td class="mdescRight">Create the DOCUMENT-START event. <a href="#gab3fd5335a5405439762ad64bc5c2dce4">More...</a><br /></td></tr> <tr class="separator:gab3fd5335a5405439762ad64bc5c2dce4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga806b89216813447629dc0a2427e35143"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga806b89216813447629dc0a2427e35143">yaml_document_end_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, int implicit)</td></tr> <tr class="memdesc:ga806b89216813447629dc0a2427e35143"><td class="mdescLeft"> </td><td class="mdescRight">Create the DOCUMENT-END event. <a href="#ga806b89216813447629dc0a2427e35143">More...</a><br /></td></tr> <tr class="separator:ga806b89216813447629dc0a2427e35143"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7070845275cc42e5743e20718ff7bb75"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga7070845275cc42e5743e20718ff7bb75">yaml_alias_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor)</td></tr> <tr class="memdesc:ga7070845275cc42e5743e20718ff7bb75"><td class="mdescLeft"> </td><td class="mdescRight">Create an ALIAS event. <a href="#ga7070845275cc42e5743e20718ff7bb75">More...</a><br /></td></tr> <tr class="separator:ga7070845275cc42e5743e20718ff7bb75"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga708a578eb91e7b278d3ac562c5cc4a76"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga708a578eb91e7b278d3ac562c5cc4a76">yaml_scalar_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, int plain_implicit, int quoted_implicit, <a class="el" href="../../d9/dca/group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr> <tr class="memdesc:ga708a578eb91e7b278d3ac562c5cc4a76"><td class="mdescLeft"> </td><td class="mdescRight">Create a SCALAR event. <a href="#ga708a578eb91e7b278d3ac562c5cc4a76">More...</a><br /></td></tr> <tr class="separator:ga708a578eb91e7b278d3ac562c5cc4a76"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5cb087fef4974f50706c5f7fefc73447"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga5cb087fef4974f50706c5f7fefc73447">yaml_sequence_start_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="../../d9/dca/group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr> <tr class="memdesc:ga5cb087fef4974f50706c5f7fefc73447"><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE-START event. <a href="#ga5cb087fef4974f50706c5f7fefc73447">More...</a><br /></td></tr> <tr class="separator:ga5cb087fef4974f50706c5f7fefc73447"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9ebf0f778c16279758af04695e156ab8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga9ebf0f778c16279758af04695e156ab8">yaml_sequence_end_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr> <tr class="memdesc:ga9ebf0f778c16279758af04695e156ab8"><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE-END event. <a href="#ga9ebf0f778c16279758af04695e156ab8">More...</a><br /></td></tr> <tr class="separator:ga9ebf0f778c16279758af04695e156ab8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga10881b4cc5ba19294dbb70537420dace"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga10881b4cc5ba19294dbb70537420dace">yaml_mapping_start_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="../../d9/dca/group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr> <tr class="memdesc:ga10881b4cc5ba19294dbb70537420dace"><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING-START event. <a href="#ga10881b4cc5ba19294dbb70537420dace">More...</a><br /></td></tr> <tr class="separator:ga10881b4cc5ba19294dbb70537420dace"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga7952fa5fa71a05d1ea85e0fe1d5f2af5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga7952fa5fa71a05d1ea85e0fe1d5f2af5">yaml_mapping_end_event_initialize</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr> <tr class="memdesc:ga7952fa5fa71a05d1ea85e0fe1d5f2af5"><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING-END event. <a href="#ga7952fa5fa71a05d1ea85e0fe1d5f2af5">More...</a><br /></td></tr> <tr class="separator:ga7952fa5fa71a05d1ea85e0fe1d5f2af5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga989c12ed4090ff45698068848d930d08"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d1/ddf/group__events.html#ga989c12ed4090ff45698068848d930d08">yaml_event_delete</a> (<a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr> <tr class="memdesc:ga989c12ed4090ff45698068848d930d08"><td class="mdescLeft"> </td><td class="mdescRight">Free any memory allocated for an event object. <a href="#ga989c12ed4090ff45698068848d930d08">More...</a><br /></td></tr> <tr class="separator:ga989c12ed4090ff45698068848d930d08"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <h2 class="groupheader">Typedef Documentation</h2> <a id="ga3b392d9716c4920cabefdd29e78dd542"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga3b392d9716c4920cabefdd29e78dd542">◆ </a></span>yaml_event_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="../../d2/d72/structyaml__event__s.html">yaml_event_s</a> <a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td> </tr> </table> </div><div class="memdoc"> <p>The event structure. </p> </div> </div> <a id="ga8934661be36bd7c9d17a8af69eff89a1"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga8934661be36bd7c9d17a8af69eff89a1">◆ </a></span>yaml_event_type_t</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef enum <a class="el" href="../../d1/ddf/group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> <a class="el" href="../../d1/ddf/group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td> </tr> </table> </div><div class="memdoc"> <p>Event types. </p> </div> </div> <h2 class="groupheader">Enumeration Type Documentation</h2> <a id="ga454fccebae859c188fe3e7fa3299577c"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga454fccebae859c188fe3e7fa3299577c">◆ </a></span>yaml_event_type_e</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="../../d1/ddf/group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a></td> </tr> </table> </div><div class="memdoc"> <p>Event types. </p> <table class="fieldtable"> <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac"></a>YAML_NO_EVENT </td><td class="fielddoc"><p>An empty event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465"></a>YAML_STREAM_START_EVENT </td><td class="fielddoc"><p>A STREAM-START event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b"></a>YAML_STREAM_END_EVENT </td><td class="fielddoc"><p>A STREAM-END event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3"></a>YAML_DOCUMENT_START_EVENT </td><td class="fielddoc"><p>A DOCUMENT-START event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f"></a>YAML_DOCUMENT_END_EVENT </td><td class="fielddoc"><p>A DOCUMENT-END event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7"></a>YAML_ALIAS_EVENT </td><td class="fielddoc"><p>An ALIAS event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713"></a>YAML_SCALAR_EVENT </td><td class="fielddoc"><p>A SCALAR event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093"></a>YAML_SEQUENCE_START_EVENT </td><td class="fielddoc"><p>A SEQUENCE-START event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898"></a>YAML_SEQUENCE_END_EVENT </td><td class="fielddoc"><p>A SEQUENCE-END event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8"></a>YAML_MAPPING_START_EVENT </td><td class="fielddoc"><p>A MAPPING-START event. </p> </td></tr> <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30"></a>YAML_MAPPING_END_EVENT </td><td class="fielddoc"><p>A MAPPING-END event. </p> </td></tr> </table> <p class="definition">Definition at line <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00353">353</a> of file <a class="el" href="../../dc/dfe/yaml_8h_source.html">yaml.h</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a id="ga7070845275cc42e5743e20718ff7bb75"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7070845275cc42e5743e20718ff7bb75">◆ </a></span>yaml_alias_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_alias_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>anchor</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create an ALIAS event. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The anchor value.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00791">791</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00574">ALIAS_EVENT_INIT</a>, <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../d4/db0/__sdbm_8c_source.html#l00102">NULL</a>, <a class="el" href="../../d6/d7b/strchr_8c.html#a219836f542ce53545052bed5353820ca">strlen()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00620">yaml_check_utf8()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00061">yaml_strdup()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00405">alias()</a>.</p> </div> </div> <a id="ga806b89216813447629dc0a2427e35143"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga806b89216813447629dc0a2427e35143">◆ </a></span>yaml_document_end_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_document_end_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>implicit</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create the DOCUMENT-END event. </p> <p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the document end indicator is implicit.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00775">775</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00570">DOCUMENT_END_EVENT_INIT</a>, and <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00197">end_document()</a>.</p> </div> </div> <a id="gab3fd5335a5405439762ad64bc5c2dce4"></a> <h2 class="memtitle"><span class="permalink"><a href="#gab3fd5335a5405439762ad64bc5c2dce4">◆ </a></span>yaml_document_start_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_document_start_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> * </td> <td class="paramname"><em>version_directive</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> * </td> <td class="paramname"><em>tag_directives_start</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> * </td> <td class="paramname"><em>tag_directives_end</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>implicit</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create the DOCUMENT-START event. </p> <p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">version_directive</td><td>The YAML directive value or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_start</td><td>The beginning of the TAG directives list. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_end</td><td>The end of the TAG directives list. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the document start indicator is implicit.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00696">696</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00562">DOCUMENT_START_EVENT_INIT</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00091">yaml_tag_directive_s::handle</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00087">INITIAL_STACK_SIZE</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00083">yaml_version_directive_s::major</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00085">yaml_version_directive_s::minor</a>, <a class="el" href="../../d4/db0/__sdbm_8c_source.html#l00102">NULL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00457">POP</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00093">yaml_tag_directive_s::prefix</a>, <a class="el" href="../../de/d07/bigdecimal_8c_source.html#l00064">PUSH</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00434">STACK_DEL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00438">STACK_EMPTY</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00426">STACK_INIT</a>, <a class="el" href="../../d6/d7b/strchr_8c.html#a219836f542ce53545052bed5353820ca">strlen()</a>, <a class="el" href="../../d6/da0/nkf-utf8_2nkf_8c_source.html#l04309">top</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00620">yaml_check_utf8()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00031">yaml_malloc()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00061">yaml_strdup()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00120">start_document()</a>.</p> </div> </div> <a id="ga989c12ed4090ff45698068848d930d08"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga989c12ed4090ff45698068848d930d08">◆ </a></span>yaml_event_delete()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_event_delete </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Free any memory allocated for an event object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object. </td></tr> </table> </dd> </dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00983">983</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00091">yaml_tag_directive_s::handle</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00093">yaml_tag_directive_s::prefix</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00368">YAML_ALIAS_EVENT</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00363">YAML_DOCUMENT_START_EVENT</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00378">YAML_MAPPING_START_EVENT</a>, <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00370">YAML_SCALAR_EVENT</a>, and <a class="el" href="../../dc/dfe/yaml_8h_source.html#l00373">YAML_SEQUENCE_START_EVENT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00229">parse()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00386">yaml_emitter_delete()</a>, and <a class="el" href="../../da/d1b/emitter_8c_source.html#l00281">yaml_emitter_emit()</a>.</p> </div> </div> <a id="ga7952fa5fa71a05d1ea85e0fe1d5f2af5"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga7952fa5fa71a05d1ea85e0fe1d5f2af5">◆ </a></span>yaml_mapping_end_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_mapping_end_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a MAPPING-END event. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00967">967</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00608">MAPPING_END_EVENT_INIT</a>, and <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00386">end_mapping()</a>.</p> </div> </div> <a id="ga10881b4cc5ba19294dbb70537420dace"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga10881b4cc5ba19294dbb70537420dace">◆ </a></span>yaml_mapping_start_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_mapping_start_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>anchor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>implicit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d9/dca/group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> </td> <td class="paramname"><em>style</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create a MAPPING-START event. </p> <p>The <em>style</em> argument may be ignored by the emitter.</p> <p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The mapping anchor or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The mapping tag or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the tag may be omitted. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The mapping style.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00928">928</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00600">MAPPING_START_EVENT_INIT</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../d4/db0/__sdbm_8c_source.html#l00102">NULL</a>, <a class="el" href="../../d6/d7b/strchr_8c.html#a219836f542ce53545052bed5353820ca">strlen()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00620">yaml_check_utf8()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00061">yaml_strdup()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00339">start_mapping()</a>.</p> </div> </div> <a id="ga708a578eb91e7b278d3ac562c5cc4a76"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga708a578eb91e7b278d3ac562c5cc4a76">◆ </a></span>yaml_scalar_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_scalar_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>anchor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>value</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>length</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>plain_implicit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>quoted_implicit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d9/dca/group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> </td> <td class="paramname"><em>style</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create a SCALAR event. </p> <p>The <em>style</em> argument may be ignored by the emitter.</p> <p>Either the <em>tag</em> attribute or one of the <em>plain_implicit</em> and <em>quoted_implicit</em> flags must be set.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The scalar anchor or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The scalar tag or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The scalar value. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the scalar value. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">plain_implicit</td><td>If the tag may be omitted for the plain style. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">quoted_implicit</td><td>If the tag may be omitted for any non-plain style. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The scalar style.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00815">815</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../d4/db0/__sdbm_8c_source.html#l00102">NULL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00578">SCALAR_EVENT_INIT</a>, <a class="el" href="../../d6/d7b/strchr_8c.html#a219836f542ce53545052bed5353820ca">strlen()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00620">yaml_check_utf8()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00031">yaml_malloc()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00061">yaml_strdup()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00217">scalar()</a>.</p> </div> </div> <a id="ga9ebf0f778c16279758af04695e156ab8"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga9ebf0f778c16279758af04695e156ab8">◆ </a></span>yaml_sequence_end_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_sequence_end_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create a SEQUENCE-END event. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00912">912</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, and <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00597">SEQUENCE_END_EVENT_INIT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00319">end_sequence()</a>.</p> </div> </div> <a id="ga5cb087fef4974f50706c5f7fefc73447"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga5cb087fef4974f50706c5f7fefc73447">◆ </a></span>yaml_sequence_start_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_sequence_start_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>anchor</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> <td class="paramname"><em>tag</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>implicit</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d9/dca/group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> </td> <td class="paramname"><em>style</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Create a SEQUENCE-START event. </p> <p>The <em>style</em> argument may be ignored by the emitter.</p> <p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The sequence anchor or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag or <code>NULL</code>. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the tag may be omitted. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00873">873</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, <a class="el" href="../../d4/db0/__sdbm_8c_source.html#l00102">NULL</a>, <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00589">SEQUENCE_START_EVENT_INIT</a>, <a class="el" href="../../d6/d7b/strchr_8c.html#a219836f542ce53545052bed5353820ca">strlen()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00620">yaml_check_utf8()</a>, <a class="el" href="../../d3/de3/api_8c_source.html#l00051">yaml_free()</a>, and <a class="el" href="../../d3/de3/api_8c_source.html#l00061">yaml_strdup()</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00274">start_sequence()</a>.</p> </div> </div> <a id="ga87c423095c6ad061d3e5c9b805286c0b"></a> <h2 class="memtitle"><span class="permalink"><a href="#ga87c423095c6ad061d3e5c9b805286c0b">◆ </a></span>yaml_stream_end_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_stream_end_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Create the STREAM-END event. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00680">680</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, and <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00559">STREAM_END_EVENT_INIT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00100">end_stream()</a>.</p> </div> </div> <a id="gad88ee2f0df5c2664506e837e7314e4f1"></a> <h2 class="memtitle"><span class="permalink"><a href="#gad88ee2f0df5c2664506e837e7314e4f1">◆ </a></span>yaml_stream_start_event_initialize()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">yaml_stream_start_event_initialize </td> <td>(</td> <td class="paramtype"><a class="el" href="../../d1/ddf/group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> * </td> <td class="paramname"><em>event</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="../../d0/df6/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> </div><div class="memdoc"> <p>Create the STREAM-START event. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The stream encoding.</td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> <p class="definition">Definition at line <a class="el" href="../../d3/de3/api_8c_source.html#l00663">663</a> of file <a class="el" href="../../d3/de3/api_8c_source.html">api.c</a>.</p> <p class="reference">References <a class="el" href="../../d5/dac/ossl_8h_source.html#l00045">assert</a>, <a class="el" href="../../d4/d54/psych__parser_8c_source.html#l00523">mark()</a>, and <a class="el" href="../../db/d71/yaml__private_8h_source.html#l00555">STREAM_START_EVENT_INIT</a>.</p> <p class="reference">Referenced by <a class="el" href="../../d3/d42/psych__emitter_8c_source.html#l00080">start_stream()</a>.</p> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="../../doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>
💾 Save Changes
❌ Cancel