doc/html/group__events.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.14"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>yaml: Events</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">yaml
  22    &#160;<span id="projectnumber">0.2.1</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.14 -->
  31 <script type="text/javascript" src="menudata.js"></script>
  32 <script type="text/javascript" src="menu.js"></script>
  33 <script type="text/javascript">
  34 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  35 $(function() {
  36   initMenu('',false,false,'search.php','Search');
  37 });
  38 /* @license-end */</script>
  39 <div id="main-nav"></div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#nested-classes">Data Structures</a> &#124;
  44 <a href="#typedef-members">Typedefs</a> &#124;
  45 <a href="#enum-members">Enumerations</a> &#124;
  46 <a href="#func-members">Functions</a>  </div>
  47   <div class="headertitle">
  48 <div class="title">Events</div>  </div>
  49 </div><!--header-->
  50 <div class="contents">
  51 <table class="memberdecls">
  52 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  53 Data Structures</h2></td></tr>
  54 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html">yaml_event_s</a></td></tr>
  55 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The event structure.  <a href="structyaml__event__s.html#details">More...</a><br /></td></tr>
  56 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 </table><table class="memberdecls">
  58 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  59 Typedefs</h2></td></tr>
  60 <tr class="memitem:ga8934661be36bd7c9d17a8af69eff89a1"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td></tr>
  61 <tr class="memdesc:ga8934661be36bd7c9d17a8af69eff89a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event types.  <a href="#ga8934661be36bd7c9d17a8af69eff89a1">More...</a><br /></td></tr>
  62 <tr class="separator:ga8934661be36bd7c9d17a8af69eff89a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63 <tr class="memitem:ga3b392d9716c4920cabefdd29e78dd542"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__event__s.html">yaml_event_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td></tr>
  64 <tr class="memdesc:ga3b392d9716c4920cabefdd29e78dd542"><td class="mdescLeft">&#160;</td><td class="mdescRight">The event structure.  <a href="#ga3b392d9716c4920cabefdd29e78dd542">More...</a><br /></td></tr>
  65 <tr class="separator:ga3b392d9716c4920cabefdd29e78dd542"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 </table><table class="memberdecls">
  67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  68 Enumerations</h2></td></tr>
  69 <tr class="memitem:ga454fccebae859c188fe3e7fa3299577c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> { <br />
  70 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac">YAML_NO_EVENT</a>,
  71 <br />
  72 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465">YAML_STREAM_START_EVENT</a>,
  73 <br />
  74 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b">YAML_STREAM_END_EVENT</a>,
  75 <br />
  76 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3">YAML_DOCUMENT_START_EVENT</a>,
  77 <br />
  78 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f">YAML_DOCUMENT_END_EVENT</a>,
  79 <br />
  80 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7">YAML_ALIAS_EVENT</a>,
  81 <br />
  82 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713">YAML_SCALAR_EVENT</a>,
  83 <br />
  84 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093">YAML_SEQUENCE_START_EVENT</a>,
  85 <br />
  86 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898">YAML_SEQUENCE_END_EVENT</a>,
  87 <br />
  88 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8">YAML_MAPPING_START_EVENT</a>,
  89 <br />
  90 &#160;&#160;<a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30">YAML_MAPPING_END_EVENT</a>
  91 <br />
  92  }</td></tr>
  93 <tr class="memdesc:ga454fccebae859c188fe3e7fa3299577c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event types.  <a href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">More...</a><br /></td></tr>
  94 <tr class="separator:ga454fccebae859c188fe3e7fa3299577c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95 </table><table class="memberdecls">
  96 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  97 Functions</h2></td></tr>
  98 <tr class="memitem:ga0650d255b23d9aae13c839f4ab3ec2ab"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga0650d255b23d9aae13c839f4ab3ec2ab">yaml_stream_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr>
  99 <tr class="memdesc:ga0650d255b23d9aae13c839f4ab3ec2ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the STREAM-START event.  <a href="#ga0650d255b23d9aae13c839f4ab3ec2ab">More...</a><br /></td></tr>
 100 <tr class="separator:ga0650d255b23d9aae13c839f4ab3ec2ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
 101 <tr class="memitem:ga84cf0c3ff01251c852c71624e64df9fe"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga84cf0c3ff01251c852c71624e64df9fe">yaml_stream_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 102 <tr class="memdesc:ga84cf0c3ff01251c852c71624e64df9fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the STREAM-END event.  <a href="#ga84cf0c3ff01251c852c71624e64df9fe">More...</a><br /></td></tr>
 103 <tr class="separator:ga84cf0c3ff01251c852c71624e64df9fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
 104 <tr class="memitem:ga527e89302e1c969fbea5aa45664bf51c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga527e89302e1c969fbea5aa45664bf51c">yaml_document_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *version_directive, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *tag_directives_end, int implicit)</td></tr>
 105 <tr class="memdesc:ga527e89302e1c969fbea5aa45664bf51c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the DOCUMENT-START event.  <a href="#ga527e89302e1c969fbea5aa45664bf51c">More...</a><br /></td></tr>
 106 <tr class="separator:ga527e89302e1c969fbea5aa45664bf51c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 107 <tr class="memitem:ga8bae16548ee88f8a5ca15204f8c30344"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga8bae16548ee88f8a5ca15204f8c30344">yaml_document_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, int implicit)</td></tr>
 108 <tr class="memdesc:ga8bae16548ee88f8a5ca15204f8c30344"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the DOCUMENT-END event.  <a href="#ga8bae16548ee88f8a5ca15204f8c30344">More...</a><br /></td></tr>
 109 <tr class="separator:ga8bae16548ee88f8a5ca15204f8c30344"><td class="memSeparator" colspan="2">&#160;</td></tr>
 110 <tr class="memitem:gade4c15b75eb9a8035e04d4f0dd23f005"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#gade4c15b75eb9a8035e04d4f0dd23f005">yaml_alias_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor)</td></tr>
 111 <tr class="memdesc:gade4c15b75eb9a8035e04d4f0dd23f005"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an ALIAS event.  <a href="#gade4c15b75eb9a8035e04d4f0dd23f005">More...</a><br /></td></tr>
 112 <tr class="separator:gade4c15b75eb9a8035e04d4f0dd23f005"><td class="memSeparator" colspan="2">&#160;</td></tr>
 113 <tr class="memitem:gafc60a1a437385e19e6fb3be075958c8c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#gafc60a1a437385e19e6fb3be075958c8c">yaml_scalar_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, int plain_implicit, int quoted_implicit, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr>
 114 <tr class="memdesc:gafc60a1a437385e19e6fb3be075958c8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SCALAR event.  <a href="#gafc60a1a437385e19e6fb3be075958c8c">More...</a><br /></td></tr>
 115 <tr class="separator:gafc60a1a437385e19e6fb3be075958c8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 116 <tr class="memitem:ga53aea428c768d7b131923d08c904b4eb"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga53aea428c768d7b131923d08c904b4eb">yaml_sequence_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr>
 117 <tr class="memdesc:ga53aea428c768d7b131923d08c904b4eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SEQUENCE-START event.  <a href="#ga53aea428c768d7b131923d08c904b4eb">More...</a><br /></td></tr>
 118 <tr class="separator:ga53aea428c768d7b131923d08c904b4eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 119 <tr class="memitem:ga99fdfa4b9d42b64d8171c9b22f334b1c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga99fdfa4b9d42b64d8171c9b22f334b1c">yaml_sequence_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 120 <tr class="memdesc:ga99fdfa4b9d42b64d8171c9b22f334b1c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a SEQUENCE-END event.  <a href="#ga99fdfa4b9d42b64d8171c9b22f334b1c">More...</a><br /></td></tr>
 121 <tr class="separator:ga99fdfa4b9d42b64d8171c9b22f334b1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 122 <tr class="memitem:ga0603cf8d20f0b6dfc3be04b6360134aa"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga0603cf8d20f0b6dfc3be04b6360134aa">yaml_mapping_start_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr>
 123 <tr class="memdesc:ga0603cf8d20f0b6dfc3be04b6360134aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a MAPPING-START event.  <a href="#ga0603cf8d20f0b6dfc3be04b6360134aa">More...</a><br /></td></tr>
 124 <tr class="separator:ga0603cf8d20f0b6dfc3be04b6360134aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
 125 <tr class="memitem:ga3afaf8b3aca2ec902a4e268f12adb0c2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga3afaf8b3aca2ec902a4e268f12adb0c2">yaml_mapping_end_event_initialize</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 126 <tr class="memdesc:ga3afaf8b3aca2ec902a4e268f12adb0c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a MAPPING-END event.  <a href="#ga3afaf8b3aca2ec902a4e268f12adb0c2">More...</a><br /></td></tr>
 127 <tr class="separator:ga3afaf8b3aca2ec902a4e268f12adb0c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
 128 <tr class="memitem:ga5330d62ef52856aa53188137cb93a6a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga5330d62ef52856aa53188137cb93a6a1">yaml_event_delete</a> (<a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *event)</td></tr>
 129 <tr class="memdesc:ga5330d62ef52856aa53188137cb93a6a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Free any memory allocated for an event object.  <a href="#ga5330d62ef52856aa53188137cb93a6a1">More...</a><br /></td></tr>
 130 <tr class="separator:ga5330d62ef52856aa53188137cb93a6a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 131 </table>
 132 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 133 <h2 class="groupheader">Typedef Documentation</h2>
 134 <a id="ga8934661be36bd7c9d17a8af69eff89a1"></a>
 135 <h2 class="memtitle"><span class="permalink"><a href="#ga8934661be36bd7c9d17a8af69eff89a1">&#9670;&nbsp;</a></span>yaml_event_type_t</h2>
 136
 137 <div class="memitem">
 138 <div class="memproto">
 139       <table class="memname">
 140         <tr>
 141           <td class="memname">typedef enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a>  <a class="el" href="group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td>
 142         </tr>
 143       </table>
 144 </div><div class="memdoc">
 145
 146 <p>Event types. </p>
 147
 148 </div>
 149 </div>
 150 <a id="ga3b392d9716c4920cabefdd29e78dd542"></a>
 151 <h2 class="memtitle"><span class="permalink"><a href="#ga3b392d9716c4920cabefdd29e78dd542">&#9670;&nbsp;</a></span>yaml_event_t</h2>
 152
 153 <div class="memitem">
 154 <div class="memproto">
 155       <table class="memname">
 156         <tr>
 157           <td class="memname">typedef struct <a class="el" href="structyaml__event__s.html">yaml_event_s</a>  <a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td>
 158         </tr>
 159       </table>
 160 </div><div class="memdoc">
 161
 162 <p>The event structure. </p>
 163
 164 </div>
 165 </div>
 166 <h2 class="groupheader">Enumeration Type Documentation</h2>
 167 <a id="ga454fccebae859c188fe3e7fa3299577c"></a>
 168 <h2 class="memtitle"><span class="permalink"><a href="#ga454fccebae859c188fe3e7fa3299577c">&#9670;&nbsp;</a></span>yaml_event_type_e</h2>
 169
 170 <div class="memitem">
 171 <div class="memproto">
 172       <table class="memname">
 173         <tr>
 174           <td class="memname">enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a></td>
 175         </tr>
 176       </table>
 177 </div><div class="memdoc">
 178
 179 <p>Event types. </p>
 180 <table class="fieldtable">
 181 <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac"></a>YAML_NO_EVENT&#160;</td><td class="fielddoc"><p>An empty event. </p>
 182 </td></tr>
 183 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465"></a>YAML_STREAM_START_EVENT&#160;</td><td class="fielddoc"><p>A STREAM-START event. </p>
 184 </td></tr>
 185 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b"></a>YAML_STREAM_END_EVENT&#160;</td><td class="fielddoc"><p>A STREAM-END event. </p>
 186 </td></tr>
 187 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3"></a>YAML_DOCUMENT_START_EVENT&#160;</td><td class="fielddoc"><p>A DOCUMENT-START event. </p>
 188 </td></tr>
 189 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f"></a>YAML_DOCUMENT_END_EVENT&#160;</td><td class="fielddoc"><p>A DOCUMENT-END event. </p>
 190 </td></tr>
 191 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7"></a>YAML_ALIAS_EVENT&#160;</td><td class="fielddoc"><p>An ALIAS event. </p>
 192 </td></tr>
 193 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713"></a>YAML_SCALAR_EVENT&#160;</td><td class="fielddoc"><p>A SCALAR event. </p>
 194 </td></tr>
 195 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093"></a>YAML_SEQUENCE_START_EVENT&#160;</td><td class="fielddoc"><p>A SEQUENCE-START event. </p>
 196 </td></tr>
 197 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898"></a>YAML_SEQUENCE_END_EVENT&#160;</td><td class="fielddoc"><p>A SEQUENCE-END event. </p>
 198 </td></tr>
 199 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8"></a>YAML_MAPPING_START_EVENT&#160;</td><td class="fielddoc"><p>A MAPPING-START event. </p>
 200 </td></tr>
 201 <tr><td class="fieldname"><a id="gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30"></a>YAML_MAPPING_END_EVENT&#160;</td><td class="fielddoc"><p>A MAPPING-END event. </p>
 202 </td></tr>
 203 </table>
 204
 205 </div>
 206 </div>
 207 <h2 class="groupheader">Function Documentation</h2>
 208 <a id="ga0650d255b23d9aae13c839f4ab3ec2ab"></a>
 209 <h2 class="memtitle"><span class="permalink"><a href="#ga0650d255b23d9aae13c839f4ab3ec2ab">&#9670;&nbsp;</a></span>yaml_stream_start_event_initialize()</h2>
 210
 211 <div class="memitem">
 212 <div class="memproto">
 213       <table class="memname">
 214         <tr>
 215           <td class="memname">int yaml_stream_start_event_initialize </td>
 216           <td>(</td>
 217           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 218           <td class="paramname"><em>event</em>, </td>
 219         </tr>
 220         <tr>
 221           <td class="paramkey"></td>
 222           <td></td>
 223           <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a>&#160;</td>
 224           <td class="paramname"><em>encoding</em>&#160;</td>
 225         </tr>
 226         <tr>
 227           <td></td>
 228           <td>)</td>
 229           <td></td><td></td>
 230         </tr>
 231       </table>
 232 </div><div class="memdoc">
 233
 234 <p>Create the STREAM-START event. </p>
 235 <dl class="params"><dt>Parameters</dt><dd>
 236   <table class="params">
 237     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 238     <tr><td class="paramdir">[in]</td><td class="paramname">encoding</td><td>The stream encoding.</td></tr>
 239   </table>
 240   </dd>
 241 </dl>
 242 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 243
 244 </div>
 245 </div>
 246 <a id="ga84cf0c3ff01251c852c71624e64df9fe"></a>
 247 <h2 class="memtitle"><span class="permalink"><a href="#ga84cf0c3ff01251c852c71624e64df9fe">&#9670;&nbsp;</a></span>yaml_stream_end_event_initialize()</h2>
 248
 249 <div class="memitem">
 250 <div class="memproto">
 251       <table class="memname">
 252         <tr>
 253           <td class="memname">int yaml_stream_end_event_initialize </td>
 254           <td>(</td>
 255           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 256           <td class="paramname"><em>event</em></td><td>)</td>
 257           <td></td>
 258         </tr>
 259       </table>
 260 </div><div class="memdoc">
 261
 262 <p>Create the STREAM-END event. </p>
 263 <dl class="params"><dt>Parameters</dt><dd>
 264   <table class="params">
 265     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 266   </table>
 267   </dd>
 268 </dl>
 269 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 270
 271 </div>
 272 </div>
 273 <a id="ga527e89302e1c969fbea5aa45664bf51c"></a>
 274 <h2 class="memtitle"><span class="permalink"><a href="#ga527e89302e1c969fbea5aa45664bf51c">&#9670;&nbsp;</a></span>yaml_document_start_event_initialize()</h2>
 275
 276 <div class="memitem">
 277 <div class="memproto">
 278       <table class="memname">
 279         <tr>
 280           <td class="memname">int yaml_document_start_event_initialize </td>
 281           <td>(</td>
 282           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 283           <td class="paramname"><em>event</em>, </td>
 284         </tr>
 285         <tr>
 286           <td class="paramkey"></td>
 287           <td></td>
 288           <td class="paramtype"><a class="el" href="group__basic.html#ga2fc55608333fbe6df17cf891be709b72">yaml_version_directive_t</a> *&#160;</td>
 289           <td class="paramname"><em>version_directive</em>, </td>
 290         </tr>
 291         <tr>
 292           <td class="paramkey"></td>
 293           <td></td>
 294           <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;</td>
 295           <td class="paramname"><em>tag_directives_start</em>, </td>
 296         </tr>
 297         <tr>
 298           <td class="paramkey"></td>
 299           <td></td>
 300           <td class="paramtype"><a class="el" href="group__basic.html#ga0b4bc4871b0c9104e32d40d5f3803674">yaml_tag_directive_t</a> *&#160;</td>
 301           <td class="paramname"><em>tag_directives_end</em>, </td>
 302         </tr>
 303         <tr>
 304           <td class="paramkey"></td>
 305           <td></td>
 306           <td class="paramtype">int&#160;</td>
 307           <td class="paramname"><em>implicit</em>&#160;</td>
 308         </tr>
 309         <tr>
 310           <td></td>
 311           <td>)</td>
 312           <td></td><td></td>
 313         </tr>
 314       </table>
 315 </div><div class="memdoc">
 316
 317 <p>Create the DOCUMENT-START event. </p>
 318 <p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p>
 319 <dl class="params"><dt>Parameters</dt><dd>
 320   <table class="params">
 321     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 322     <tr><td class="paramdir">[in]</td><td class="paramname">version_directive</td><td>The YAML directive value or <code>NULL</code>. </td></tr>
 323     <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_start</td><td>The beginning of the TAG directives list. </td></tr>
 324     <tr><td class="paramdir">[in]</td><td class="paramname">tag_directives_end</td><td>The end of the TAG directives list. </td></tr>
 325     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the document start indicator is implicit.</td></tr>
 326   </table>
 327   </dd>
 328 </dl>
 329 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 330
 331 </div>
 332 </div>
 333 <a id="ga8bae16548ee88f8a5ca15204f8c30344"></a>
 334 <h2 class="memtitle"><span class="permalink"><a href="#ga8bae16548ee88f8a5ca15204f8c30344">&#9670;&nbsp;</a></span>yaml_document_end_event_initialize()</h2>
 335
 336 <div class="memitem">
 337 <div class="memproto">
 338       <table class="memname">
 339         <tr>
 340           <td class="memname">int yaml_document_end_event_initialize </td>
 341           <td>(</td>
 342           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 343           <td class="paramname"><em>event</em>, </td>
 344         </tr>
 345         <tr>
 346           <td class="paramkey"></td>
 347           <td></td>
 348           <td class="paramtype">int&#160;</td>
 349           <td class="paramname"><em>implicit</em>&#160;</td>
 350         </tr>
 351         <tr>
 352           <td></td>
 353           <td>)</td>
 354           <td></td><td></td>
 355         </tr>
 356       </table>
 357 </div><div class="memdoc">
 358
 359 <p>Create the DOCUMENT-END event. </p>
 360 <p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p>
 361 <dl class="params"><dt>Parameters</dt><dd>
 362   <table class="params">
 363     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 364     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the document end indicator is implicit.</td></tr>
 365   </table>
 366   </dd>
 367 </dl>
 368 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 369
 370 </div>
 371 </div>
 372 <a id="gade4c15b75eb9a8035e04d4f0dd23f005"></a>
 373 <h2 class="memtitle"><span class="permalink"><a href="#gade4c15b75eb9a8035e04d4f0dd23f005">&#9670;&nbsp;</a></span>yaml_alias_event_initialize()</h2>
 374
 375 <div class="memitem">
 376 <div class="memproto">
 377       <table class="memname">
 378         <tr>
 379           <td class="memname">int yaml_alias_event_initialize </td>
 380           <td>(</td>
 381           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 382           <td class="paramname"><em>event</em>, </td>
 383         </tr>
 384         <tr>
 385           <td class="paramkey"></td>
 386           <td></td>
 387           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 388           <td class="paramname"><em>anchor</em>&#160;</td>
 389         </tr>
 390         <tr>
 391           <td></td>
 392           <td>)</td>
 393           <td></td><td></td>
 394         </tr>
 395       </table>
 396 </div><div class="memdoc">
 397
 398 <p>Create an ALIAS event. </p>
 399 <dl class="params"><dt>Parameters</dt><dd>
 400   <table class="params">
 401     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 402     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The anchor value.</td></tr>
 403   </table>
 404   </dd>
 405 </dl>
 406 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 407
 408 </div>
 409 </div>
 410 <a id="gafc60a1a437385e19e6fb3be075958c8c"></a>
 411 <h2 class="memtitle"><span class="permalink"><a href="#gafc60a1a437385e19e6fb3be075958c8c">&#9670;&nbsp;</a></span>yaml_scalar_event_initialize()</h2>
 412
 413 <div class="memitem">
 414 <div class="memproto">
 415       <table class="memname">
 416         <tr>
 417           <td class="memname">int yaml_scalar_event_initialize </td>
 418           <td>(</td>
 419           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 420           <td class="paramname"><em>event</em>, </td>
 421         </tr>
 422         <tr>
 423           <td class="paramkey"></td>
 424           <td></td>
 425           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 426           <td class="paramname"><em>anchor</em>, </td>
 427         </tr>
 428         <tr>
 429           <td class="paramkey"></td>
 430           <td></td>
 431           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 432           <td class="paramname"><em>tag</em>, </td>
 433         </tr>
 434         <tr>
 435           <td class="paramkey"></td>
 436           <td></td>
 437           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 438           <td class="paramname"><em>value</em>, </td>
 439         </tr>
 440         <tr>
 441           <td class="paramkey"></td>
 442           <td></td>
 443           <td class="paramtype">int&#160;</td>
 444           <td class="paramname"><em>length</em>, </td>
 445         </tr>
 446         <tr>
 447           <td class="paramkey"></td>
 448           <td></td>
 449           <td class="paramtype">int&#160;</td>
 450           <td class="paramname"><em>plain_implicit</em>, </td>
 451         </tr>
 452         <tr>
 453           <td class="paramkey"></td>
 454           <td></td>
 455           <td class="paramtype">int&#160;</td>
 456           <td class="paramname"><em>quoted_implicit</em>, </td>
 457         </tr>
 458         <tr>
 459           <td class="paramkey"></td>
 460           <td></td>
 461           <td class="paramtype"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a>&#160;</td>
 462           <td class="paramname"><em>style</em>&#160;</td>
 463         </tr>
 464         <tr>
 465           <td></td>
 466           <td>)</td>
 467           <td></td><td></td>
 468         </tr>
 469       </table>
 470 </div><div class="memdoc">
 471
 472 <p>Create a SCALAR event. </p>
 473 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 474 <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>
 475 <dl class="params"><dt>Parameters</dt><dd>
 476   <table class="params">
 477     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 478     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The scalar anchor or <code>NULL</code>. </td></tr>
 479     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The scalar tag or <code>NULL</code>. </td></tr>
 480     <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The scalar value. </td></tr>
 481     <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The length of the scalar value. </td></tr>
 482     <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>
 483     <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>
 484     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The scalar style.</td></tr>
 485   </table>
 486   </dd>
 487 </dl>
 488 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 489
 490 </div>
 491 </div>
 492 <a id="ga53aea428c768d7b131923d08c904b4eb"></a>
 493 <h2 class="memtitle"><span class="permalink"><a href="#ga53aea428c768d7b131923d08c904b4eb">&#9670;&nbsp;</a></span>yaml_sequence_start_event_initialize()</h2>
 494
 495 <div class="memitem">
 496 <div class="memproto">
 497       <table class="memname">
 498         <tr>
 499           <td class="memname">int yaml_sequence_start_event_initialize </td>
 500           <td>(</td>
 501           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 502           <td class="paramname"><em>event</em>, </td>
 503         </tr>
 504         <tr>
 505           <td class="paramkey"></td>
 506           <td></td>
 507           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 508           <td class="paramname"><em>anchor</em>, </td>
 509         </tr>
 510         <tr>
 511           <td class="paramkey"></td>
 512           <td></td>
 513           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 514           <td class="paramname"><em>tag</em>, </td>
 515         </tr>
 516         <tr>
 517           <td class="paramkey"></td>
 518           <td></td>
 519           <td class="paramtype">int&#160;</td>
 520           <td class="paramname"><em>implicit</em>, </td>
 521         </tr>
 522         <tr>
 523           <td class="paramkey"></td>
 524           <td></td>
 525           <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a>&#160;</td>
 526           <td class="paramname"><em>style</em>&#160;</td>
 527         </tr>
 528         <tr>
 529           <td></td>
 530           <td>)</td>
 531           <td></td><td></td>
 532         </tr>
 533       </table>
 534 </div><div class="memdoc">
 535
 536 <p>Create a SEQUENCE-START event. </p>
 537 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 538 <p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p>
 539 <dl class="params"><dt>Parameters</dt><dd>
 540   <table class="params">
 541     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 542     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The sequence anchor or <code>NULL</code>. </td></tr>
 543     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The sequence tag or <code>NULL</code>. </td></tr>
 544     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the tag may be omitted. </td></tr>
 545     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The sequence style.</td></tr>
 546   </table>
 547   </dd>
 548 </dl>
 549 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 550
 551 </div>
 552 </div>
 553 <a id="ga99fdfa4b9d42b64d8171c9b22f334b1c"></a>
 554 <h2 class="memtitle"><span class="permalink"><a href="#ga99fdfa4b9d42b64d8171c9b22f334b1c">&#9670;&nbsp;</a></span>yaml_sequence_end_event_initialize()</h2>
 555
 556 <div class="memitem">
 557 <div class="memproto">
 558       <table class="memname">
 559         <tr>
 560           <td class="memname">int yaml_sequence_end_event_initialize </td>
 561           <td>(</td>
 562           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 563           <td class="paramname"><em>event</em></td><td>)</td>
 564           <td></td>
 565         </tr>
 566       </table>
 567 </div><div class="memdoc">
 568
 569 <p>Create a SEQUENCE-END event. </p>
 570 <dl class="params"><dt>Parameters</dt><dd>
 571   <table class="params">
 572     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 573   </table>
 574   </dd>
 575 </dl>
 576 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 577
 578 </div>
 579 </div>
 580 <a id="ga0603cf8d20f0b6dfc3be04b6360134aa"></a>
 581 <h2 class="memtitle"><span class="permalink"><a href="#ga0603cf8d20f0b6dfc3be04b6360134aa">&#9670;&nbsp;</a></span>yaml_mapping_start_event_initialize()</h2>
 582
 583 <div class="memitem">
 584 <div class="memproto">
 585       <table class="memname">
 586         <tr>
 587           <td class="memname">int yaml_mapping_start_event_initialize </td>
 588           <td>(</td>
 589           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 590           <td class="paramname"><em>event</em>, </td>
 591         </tr>
 592         <tr>
 593           <td class="paramkey"></td>
 594           <td></td>
 595           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 596           <td class="paramname"><em>anchor</em>, </td>
 597         </tr>
 598         <tr>
 599           <td class="paramkey"></td>
 600           <td></td>
 601           <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *&#160;</td>
 602           <td class="paramname"><em>tag</em>, </td>
 603         </tr>
 604         <tr>
 605           <td class="paramkey"></td>
 606           <td></td>
 607           <td class="paramtype">int&#160;</td>
 608           <td class="paramname"><em>implicit</em>, </td>
 609         </tr>
 610         <tr>
 611           <td class="paramkey"></td>
 612           <td></td>
 613           <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a>&#160;</td>
 614           <td class="paramname"><em>style</em>&#160;</td>
 615         </tr>
 616         <tr>
 617           <td></td>
 618           <td>)</td>
 619           <td></td><td></td>
 620         </tr>
 621       </table>
 622 </div><div class="memdoc">
 623
 624 <p>Create a MAPPING-START event. </p>
 625 <p>The <em>style</em> argument may be ignored by the emitter.</p>
 626 <p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p>
 627 <dl class="params"><dt>Parameters</dt><dd>
 628   <table class="params">
 629     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object. </td></tr>
 630     <tr><td class="paramdir">[in]</td><td class="paramname">anchor</td><td>The mapping anchor or <code>NULL</code>. </td></tr>
 631     <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The mapping tag or <code>NULL</code>. </td></tr>
 632     <tr><td class="paramdir">[in]</td><td class="paramname">implicit</td><td>If the tag may be omitted. </td></tr>
 633     <tr><td class="paramdir">[in]</td><td class="paramname">style</td><td>The mapping style.</td></tr>
 634   </table>
 635   </dd>
 636 </dl>
 637 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 638
 639 </div>
 640 </div>
 641 <a id="ga3afaf8b3aca2ec902a4e268f12adb0c2"></a>
 642 <h2 class="memtitle"><span class="permalink"><a href="#ga3afaf8b3aca2ec902a4e268f12adb0c2">&#9670;&nbsp;</a></span>yaml_mapping_end_event_initialize()</h2>
 643
 644 <div class="memitem">
 645 <div class="memproto">
 646       <table class="memname">
 647         <tr>
 648           <td class="memname">int yaml_mapping_end_event_initialize </td>
 649           <td>(</td>
 650           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 651           <td class="paramname"><em>event</em></td><td>)</td>
 652           <td></td>
 653         </tr>
 654       </table>
 655 </div><div class="memdoc">
 656
 657 <p>Create a MAPPING-END event. </p>
 658 <dl class="params"><dt>Parameters</dt><dd>
 659   <table class="params">
 660     <tr><td class="paramdir">[out]</td><td class="paramname">event</td><td>An empty event object.</td></tr>
 661   </table>
 662   </dd>
 663 </dl>
 664 <dl class="section return"><dt>Returns</dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl>
 665
 666 </div>
 667 </div>
 668 <a id="ga5330d62ef52856aa53188137cb93a6a1"></a>
 669 <h2 class="memtitle"><span class="permalink"><a href="#ga5330d62ef52856aa53188137cb93a6a1">&#9670;&nbsp;</a></span>yaml_event_delete()</h2>
 670
 671 <div class="memitem">
 672 <div class="memproto">
 673       <table class="memname">
 674         <tr>
 675           <td class="memname">void yaml_event_delete </td>
 676           <td>(</td>
 677           <td class="paramtype"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a> *&#160;</td>
 678           <td class="paramname"><em>event</em></td><td>)</td>
 679           <td></td>
 680         </tr>
 681       </table>
 682 </div><div class="memdoc">
 683
 684 <p>Free any memory allocated for an event object. </p>
 685 <dl class="params"><dt>Parameters</dt><dd>
 686   <table class="params">
 687     <tr><td class="paramdir">[in,out]</td><td class="paramname">event</td><td>An event object. </td></tr>
 688   </table>
 689   </dd>
 690 </dl>
 691
 692 </div>
 693 </div>
 694 </div><!-- contents -->
 695 <!-- start footer part -->
 696 <hr class="footer"/><address class="footer"><small>
 697 Generated by &#160;<a href="http://www.doxygen.org/index.html">
 698 <img class="footer" src="doxygen.png" alt="doxygen"/>
 699 </a> 1.8.14
 700 </small></address>
 701 </body>
 702 </html>