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