source: trunk/packages/libyaml/doc/html/group__events.html @ 1580

Last change on this file since 1580 was 898, checked in by hartmans, 16 years ago

Add pyyaml and libyaml packages
backported from lenny.
There is discussion about how these should go in the repository; these are added in this form
in order to make forward progress.

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