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