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