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