1247738Sbapt<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2247738Sbapt<html xmlns="http://www.w3.org/1999/xhtml"> 3247738Sbapt<head> 4247738Sbapt<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> 5247738Sbapt<title>yaml: Events</title> 6247738Sbapt<link href="tabs.css" rel="stylesheet" type="text/css"/> 7247738Sbapt<link href="doxygen.css" rel="stylesheet" type="text/css"/> 8247738Sbapt</head> 9247738Sbapt<body> 10247738Sbapt<!-- Generated by Doxygen 1.7.1 --> 11247738Sbapt<div class="navigation" id="top"> 12247738Sbapt <div class="tabs"> 13247738Sbapt <ul class="tablist"> 14247738Sbapt <li><a href="index.html"><span>Main Page</span></a></li> 15247738Sbapt <li><a href="modules.html"><span>Modules</span></a></li> 16247738Sbapt <li><a href="annotated.html"><span>Data Structures</span></a></li> 17247738Sbapt <li><a href="files.html"><span>Files</span></a></li> 18247738Sbapt </ul> 19247738Sbapt </div> 20247738Sbapt</div> 21247738Sbapt<div class="header"> 22247738Sbapt <div class="summary"> 23247738Sbapt<a href="#nested-classes">Data Structures</a> | 24247738Sbapt<a href="#typedef-members">Typedefs</a> | 25247738Sbapt<a href="#enum-members">Enumerations</a> | 26247738Sbapt<a href="#func-members">Functions</a> </div> 27247738Sbapt <div class="headertitle"> 28247738Sbapt<h1>Events</h1> </div> 29247738Sbapt</div> 30247738Sbapt<div class="contents"> 31247738Sbapt<table class="memberdecls"> 32247738Sbapt<tr><td colspan="2"><h2><a name="nested-classes"></a> 33247738SbaptData Structures</h2></td></tr> 34247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__event__s.html">yaml_event_s</a></td></tr> 35247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The event structure. <a href="structyaml__event__s.html#_details">More...</a><br/></td></tr> 36247738Sbapt<tr><td colspan="2"><h2><a name="typedef-members"></a> 37247738SbaptTypedefs</h2></td></tr> 38247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga8934661be36bd7c9d17a8af69eff89a1">yaml_event_type_t</a></td></tr> 39247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Event types. <a href="#ga8934661be36bd7c9d17a8af69eff89a1"></a><br/></td></tr> 40247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__event__s.html">yaml_event_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga3b392d9716c4920cabefdd29e78dd542">yaml_event_t</a></td></tr> 41247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The event structure. <a href="#ga3b392d9716c4920cabefdd29e78dd542"></a><br/></td></tr> 42247738Sbapt<tr><td colspan="2"><h2><a name="enum-members"></a> 43247738SbaptEnumerations</h2></td></tr> 44247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a> { <br/> 45247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac">YAML_NO_EVENT</a>, 46247738Sbapt<br/> 47247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465">YAML_STREAM_START_EVENT</a>, 48247738Sbapt<br/> 49247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b">YAML_STREAM_END_EVENT</a>, 50247738Sbapt<br/> 51247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3">YAML_DOCUMENT_START_EVENT</a>, 52247738Sbapt<br/> 53247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f">YAML_DOCUMENT_END_EVENT</a>, 54247738Sbapt<br/> 55247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7">YAML_ALIAS_EVENT</a>, 56247738Sbapt<br/> 57247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713">YAML_SCALAR_EVENT</a>, 58247738Sbapt<br/> 59247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093">YAML_SEQUENCE_START_EVENT</a>, 60247738Sbapt<br/> 61247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898">YAML_SEQUENCE_END_EVENT</a>, 62247738Sbapt<br/> 63247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8">YAML_MAPPING_START_EVENT</a>, 64247738Sbapt<br/> 65247738Sbapt <a class="el" href="group__events.html#gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30">YAML_MAPPING_END_EVENT</a> 66247738Sbapt<br/> 67247738Sbapt }</td></tr> 68247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Event types. </p> 69247738Sbapt <a href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">More...</a><br/></td></tr> 70247738Sbapt<tr><td colspan="2"><h2><a name="func-members"></a> 71247738SbaptFunctions</h2></td></tr> 72247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga0650d255b23d9aae13c839f4ab3ec2ab">yaml_stream_start_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, <a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> encoding)</td></tr> 73247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the STREAM-START event. <a href="#ga0650d255b23d9aae13c839f4ab3ec2ab"></a><br/></td></tr> 74247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga84cf0c3ff01251c852c71624e64df9fe">yaml_stream_end_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event)</td></tr> 75247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the STREAM-END event. <a href="#ga84cf0c3ff01251c852c71624e64df9fe"></a><br/></td></tr> 76247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga527e89302e1c969fbea5aa45664bf51c">yaml_document_start_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, <a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> *version_directive, <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *tag_directives_start, <a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> *tag_directives_end, int implicit)</td></tr> 77247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the DOCUMENT-START event. <a href="#ga527e89302e1c969fbea5aa45664bf51c"></a><br/></td></tr> 78247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga8bae16548ee88f8a5ca15204f8c30344">yaml_document_end_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, int implicit)</td></tr> 79247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create the DOCUMENT-END event. <a href="#ga8bae16548ee88f8a5ca15204f8c30344"></a><br/></td></tr> 80247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#gade4c15b75eb9a8035e04d4f0dd23f005">yaml_alias_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor)</td></tr> 81247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an ALIAS event. <a href="#gade4c15b75eb9a8035e04d4f0dd23f005"></a><br/></td></tr> 82247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#gafc60a1a437385e19e6fb3be075958c8c">yaml_scalar_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *value, int length, int plain_implicit, int quoted_implicit, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr> 83247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SCALAR event. <a href="#gafc60a1a437385e19e6fb3be075958c8c"></a><br/></td></tr> 84247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga53aea428c768d7b131923d08c904b4eb">yaml_sequence_start_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr> 85247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE-START event. <a href="#ga53aea428c768d7b131923d08c904b4eb"></a><br/></td></tr> 86247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga99fdfa4b9d42b64d8171c9b22f334b1c">yaml_sequence_end_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event)</td></tr> 87247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE-END event. <a href="#ga99fdfa4b9d42b64d8171c9b22f334b1c"></a><br/></td></tr> 88247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga0603cf8d20f0b6dfc3be04b6360134aa">yaml_mapping_start_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *anchor, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, int implicit, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr> 89247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING-START event. <a href="#ga0603cf8d20f0b6dfc3be04b6360134aa"></a><br/></td></tr> 90247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga3afaf8b3aca2ec902a4e268f12adb0c2">yaml_mapping_end_event_initialize</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event)</td></tr> 91247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING-END event. <a href="#ga3afaf8b3aca2ec902a4e268f12adb0c2"></a><br/></td></tr> 92247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__events.html#ga5330d62ef52856aa53188137cb93a6a1">yaml_event_delete</a> (<a class="el" href="structyaml__event__s.html">yaml_event_t</a> *event)</td></tr> 93247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Free any memory allocated for an event object. <a href="#ga5330d62ef52856aa53188137cb93a6a1"></a><br/></td></tr> 94247738Sbapt</table> 95247738Sbapt<hr/><h2>Typedef Documentation</h2> 96247738Sbapt<a class="anchor" id="ga8934661be36bd7c9d17a8af69eff89a1"></a><!-- doxytag: member="yaml.h::yaml_event_type_t" ref="ga8934661be36bd7c9d17a8af69eff89a1" args="" --> 97247738Sbapt<div class="memitem"> 98247738Sbapt<div class="memproto"> 99247738Sbapt <table class="memname"> 100247738Sbapt <tr> 101247738Sbapt <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> 102247738Sbapt </tr> 103247738Sbapt </table> 104247738Sbapt</div> 105247738Sbapt<div class="memdoc"> 106247738Sbapt 107247738Sbapt<p>Event types. </p> 108247738Sbapt 109247738Sbapt</div> 110247738Sbapt</div> 111247738Sbapt<a class="anchor" id="ga3b392d9716c4920cabefdd29e78dd542"></a><!-- doxytag: member="yaml.h::yaml_event_t" ref="ga3b392d9716c4920cabefdd29e78dd542" args="" --> 112247738Sbapt<div class="memitem"> 113247738Sbapt<div class="memproto"> 114247738Sbapt <table class="memname"> 115247738Sbapt <tr> 116247738Sbapt <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> 117247738Sbapt </tr> 118247738Sbapt </table> 119247738Sbapt</div> 120247738Sbapt<div class="memdoc"> 121247738Sbapt 122247738Sbapt<p>The event structure. </p> 123247738Sbapt 124247738Sbapt</div> 125247738Sbapt</div> 126247738Sbapt<hr/><h2>Enumeration Type Documentation</h2> 127247738Sbapt<a class="anchor" id="ga454fccebae859c188fe3e7fa3299577c"></a><!-- doxytag: member="yaml.h::yaml_event_type_e" ref="ga454fccebae859c188fe3e7fa3299577c" args="" --> 128247738Sbapt<div class="memitem"> 129247738Sbapt<div class="memproto"> 130247738Sbapt <table class="memname"> 131247738Sbapt <tr> 132247738Sbapt <td class="memname">enum <a class="el" href="group__events.html#ga454fccebae859c188fe3e7fa3299577c">yaml_event_type_e</a></td> 133247738Sbapt </tr> 134247738Sbapt </table> 135247738Sbapt</div> 136247738Sbapt<div class="memdoc"> 137247738Sbapt 138247738Sbapt<p>Event types. </p> 139247738Sbapt<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 140247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac"></a><!-- doxytag: member="YAML_NO_EVENT" ref="gga454fccebae859c188fe3e7fa3299577caefda9f31823fe534f094f4241d5e5eac" args="" -->YAML_NO_EVENT</em> </td><td> 141247738Sbapt<p>An empty event. </p> 142247738Sbapt</td></tr> 143247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465"></a><!-- doxytag: member="YAML_STREAM_START_EVENT" ref="gga454fccebae859c188fe3e7fa3299577caa742e9970f14d1fe7ce4d178d79e8465" args="" -->YAML_STREAM_START_EVENT</em> </td><td> 144247738Sbapt<p>A STREAM-START event. </p> 145247738Sbapt</td></tr> 146247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b"></a><!-- doxytag: member="YAML_STREAM_END_EVENT" ref="gga454fccebae859c188fe3e7fa3299577ca4a5e76ed540645102a13352af2503d3b" args="" -->YAML_STREAM_END_EVENT</em> </td><td> 147247738Sbapt<p>A STREAM-END event. </p> 148247738Sbapt</td></tr> 149247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3"></a><!-- doxytag: member="YAML_DOCUMENT_START_EVENT" ref="gga454fccebae859c188fe3e7fa3299577caf4ca2b0f538029cf054cdebd09d3d6d3" args="" -->YAML_DOCUMENT_START_EVENT</em> </td><td> 150247738Sbapt<p>A DOCUMENT-START event. </p> 151247738Sbapt</td></tr> 152247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f"></a><!-- doxytag: member="YAML_DOCUMENT_END_EVENT" ref="gga454fccebae859c188fe3e7fa3299577ca355ec471f963827c96512e529676276f" args="" -->YAML_DOCUMENT_END_EVENT</em> </td><td> 153247738Sbapt<p>A DOCUMENT-END event. </p> 154247738Sbapt</td></tr> 155247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7"></a><!-- doxytag: member="YAML_ALIAS_EVENT" ref="gga454fccebae859c188fe3e7fa3299577ca8c3ce47705cfbd49a87a32bdbe544eb7" args="" -->YAML_ALIAS_EVENT</em> </td><td> 156247738Sbapt<p>An ALIAS event. </p> 157247738Sbapt</td></tr> 158247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713"></a><!-- doxytag: member="YAML_SCALAR_EVENT" ref="gga454fccebae859c188fe3e7fa3299577ca8b16dc795bb228e33d647d1bdf683713" args="" -->YAML_SCALAR_EVENT</em> </td><td> 159247738Sbapt<p>A SCALAR event. </p> 160247738Sbapt</td></tr> 161247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093"></a><!-- doxytag: member="YAML_SEQUENCE_START_EVENT" ref="gga454fccebae859c188fe3e7fa3299577cad90ccd43e238221f542defa3c8eaf093" args="" -->YAML_SEQUENCE_START_EVENT</em> </td><td> 162247738Sbapt<p>A SEQUENCE-START event. </p> 163247738Sbapt</td></tr> 164247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898"></a><!-- doxytag: member="YAML_SEQUENCE_END_EVENT" ref="gga454fccebae859c188fe3e7fa3299577ca2a8af98529275987d73eb307b6a92898" args="" -->YAML_SEQUENCE_END_EVENT</em> </td><td> 165247738Sbapt<p>A SEQUENCE-END event. </p> 166247738Sbapt</td></tr> 167247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8"></a><!-- doxytag: member="YAML_MAPPING_START_EVENT" ref="gga454fccebae859c188fe3e7fa3299577ca0f6982f6d1c325ee71af518c2c66dae8" args="" -->YAML_MAPPING_START_EVENT</em> </td><td> 168247738Sbapt<p>A MAPPING-START event. </p> 169247738Sbapt</td></tr> 170247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30"></a><!-- doxytag: member="YAML_MAPPING_END_EVENT" ref="gga454fccebae859c188fe3e7fa3299577cadc3dc55f17056a657005fecfb80fbd30" args="" -->YAML_MAPPING_END_EVENT</em> </td><td> 171247738Sbapt<p>A MAPPING-END event. </p> 172247738Sbapt</td></tr> 173247738Sbapt</table> 174247738Sbapt</dd> 175247738Sbapt</dl> 176247738Sbapt 177247738Sbapt</div> 178247738Sbapt</div> 179247738Sbapt<hr/><h2>Function Documentation</h2> 180247738Sbapt<a class="anchor" id="ga0650d255b23d9aae13c839f4ab3ec2ab"></a><!-- doxytag: member="yaml.h::yaml_stream_start_event_initialize" ref="ga0650d255b23d9aae13c839f4ab3ec2ab" args="(yaml_event_t *event, yaml_encoding_t encoding)" --> 181247738Sbapt<div class="memitem"> 182247738Sbapt<div class="memproto"> 183247738Sbapt <table class="memname"> 184247738Sbapt <tr> 185247738Sbapt <td class="memname">int yaml_stream_start_event_initialize </td> 186247738Sbapt <td>(</td> 187247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 188247738Sbapt <td class="paramname"> <em>event</em>, </td> 189247738Sbapt </tr> 190247738Sbapt <tr> 191247738Sbapt <td class="paramkey"></td> 192247738Sbapt <td></td> 193247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#ga2170996d7e636397b5e6bc0c1b7df7c6">yaml_encoding_t</a> </td> 194247738Sbapt <td class="paramname"> <em>encoding</em></td><td> </td> 195247738Sbapt </tr> 196247738Sbapt <tr> 197247738Sbapt <td></td> 198247738Sbapt <td>)</td> 199247738Sbapt <td></td><td></td><td></td> 200247738Sbapt </tr> 201247738Sbapt </table> 202247738Sbapt</div> 203247738Sbapt<div class="memdoc"> 204247738Sbapt 205247738Sbapt<p>Create the STREAM-START event. </p> 206247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 207247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 208247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 209247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>encoding</em> </td><td>The stream encoding.</td></tr> 210247738Sbapt </table> 211247738Sbapt </dd> 212247738Sbapt</dl> 213247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 214247738Sbapt 215247738Sbapt</div> 216247738Sbapt</div> 217247738Sbapt<a class="anchor" id="ga84cf0c3ff01251c852c71624e64df9fe"></a><!-- doxytag: member="yaml.h::yaml_stream_end_event_initialize" ref="ga84cf0c3ff01251c852c71624e64df9fe" args="(yaml_event_t *event)" --> 218247738Sbapt<div class="memitem"> 219247738Sbapt<div class="memproto"> 220247738Sbapt <table class="memname"> 221247738Sbapt <tr> 222247738Sbapt <td class="memname">int yaml_stream_end_event_initialize </td> 223247738Sbapt <td>(</td> 224247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 225247738Sbapt <td class="paramname"> <em>event</em></td> 226247738Sbapt <td> ) </td> 227247738Sbapt <td></td> 228247738Sbapt </tr> 229247738Sbapt </table> 230247738Sbapt</div> 231247738Sbapt<div class="memdoc"> 232247738Sbapt 233247738Sbapt<p>Create the STREAM-END event. </p> 234247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 235247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 236247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object.</td></tr> 237247738Sbapt </table> 238247738Sbapt </dd> 239247738Sbapt</dl> 240247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 241247738Sbapt 242247738Sbapt</div> 243247738Sbapt</div> 244247738Sbapt<a class="anchor" id="ga527e89302e1c969fbea5aa45664bf51c"></a><!-- doxytag: member="yaml.h::yaml_document_start_event_initialize" ref="ga527e89302e1c969fbea5aa45664bf51c" args="(yaml_event_t *event, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int implicit)" --> 245247738Sbapt<div class="memitem"> 246247738Sbapt<div class="memproto"> 247247738Sbapt <table class="memname"> 248247738Sbapt <tr> 249247738Sbapt <td class="memname">int yaml_document_start_event_initialize </td> 250247738Sbapt <td>(</td> 251247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 252247738Sbapt <td class="paramname"> <em>event</em>, </td> 253247738Sbapt </tr> 254247738Sbapt <tr> 255247738Sbapt <td class="paramkey"></td> 256247738Sbapt <td></td> 257247738Sbapt <td class="paramtype"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> * </td> 258247738Sbapt <td class="paramname"> <em>version_directive</em>, </td> 259247738Sbapt </tr> 260247738Sbapt <tr> 261247738Sbapt <td class="paramkey"></td> 262247738Sbapt <td></td> 263247738Sbapt <td class="paramtype"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> * </td> 264247738Sbapt <td class="paramname"> <em>tag_directives_start</em>, </td> 265247738Sbapt </tr> 266247738Sbapt <tr> 267247738Sbapt <td class="paramkey"></td> 268247738Sbapt <td></td> 269247738Sbapt <td class="paramtype"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> * </td> 270247738Sbapt <td class="paramname"> <em>tag_directives_end</em>, </td> 271247738Sbapt </tr> 272247738Sbapt <tr> 273247738Sbapt <td class="paramkey"></td> 274247738Sbapt <td></td> 275247738Sbapt <td class="paramtype">int </td> 276247738Sbapt <td class="paramname"> <em>implicit</em></td><td> </td> 277247738Sbapt </tr> 278247738Sbapt <tr> 279247738Sbapt <td></td> 280247738Sbapt <td>)</td> 281247738Sbapt <td></td><td></td><td></td> 282247738Sbapt </tr> 283247738Sbapt </table> 284247738Sbapt</div> 285247738Sbapt<div class="memdoc"> 286247738Sbapt 287247738Sbapt<p>Create the DOCUMENT-START event. </p> 288247738Sbapt<p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p> 289247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 290247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 291247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 292247738Sbapt <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> 293247738Sbapt <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> 294247738Sbapt <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> 295247738Sbapt <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> 296247738Sbapt </table> 297247738Sbapt </dd> 298247738Sbapt</dl> 299247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 300247738Sbapt 301247738Sbapt</div> 302247738Sbapt</div> 303247738Sbapt<a class="anchor" id="ga8bae16548ee88f8a5ca15204f8c30344"></a><!-- doxytag: member="yaml.h::yaml_document_end_event_initialize" ref="ga8bae16548ee88f8a5ca15204f8c30344" args="(yaml_event_t *event, int implicit)" --> 304247738Sbapt<div class="memitem"> 305247738Sbapt<div class="memproto"> 306247738Sbapt <table class="memname"> 307247738Sbapt <tr> 308247738Sbapt <td class="memname">int yaml_document_end_event_initialize </td> 309247738Sbapt <td>(</td> 310247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 311247738Sbapt <td class="paramname"> <em>event</em>, </td> 312247738Sbapt </tr> 313247738Sbapt <tr> 314247738Sbapt <td class="paramkey"></td> 315247738Sbapt <td></td> 316247738Sbapt <td class="paramtype">int </td> 317247738Sbapt <td class="paramname"> <em>implicit</em></td><td> </td> 318247738Sbapt </tr> 319247738Sbapt <tr> 320247738Sbapt <td></td> 321247738Sbapt <td>)</td> 322247738Sbapt <td></td><td></td><td></td> 323247738Sbapt </tr> 324247738Sbapt </table> 325247738Sbapt</div> 326247738Sbapt<div class="memdoc"> 327247738Sbapt 328247738Sbapt<p>Create the DOCUMENT-END event. </p> 329247738Sbapt<p>The <em>implicit</em> argument is considered as a stylistic parameter and may be ignored by the emitter.</p> 330247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 331247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 332247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 333247738Sbapt <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> 334247738Sbapt </table> 335247738Sbapt </dd> 336247738Sbapt</dl> 337247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 338247738Sbapt 339247738Sbapt</div> 340247738Sbapt</div> 341247738Sbapt<a class="anchor" id="gade4c15b75eb9a8035e04d4f0dd23f005"></a><!-- doxytag: member="yaml.h::yaml_alias_event_initialize" ref="gade4c15b75eb9a8035e04d4f0dd23f005" args="(yaml_event_t *event, yaml_char_t *anchor)" --> 342247738Sbapt<div class="memitem"> 343247738Sbapt<div class="memproto"> 344247738Sbapt <table class="memname"> 345247738Sbapt <tr> 346247738Sbapt <td class="memname">int yaml_alias_event_initialize </td> 347247738Sbapt <td>(</td> 348247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 349247738Sbapt <td class="paramname"> <em>event</em>, </td> 350247738Sbapt </tr> 351247738Sbapt <tr> 352247738Sbapt <td class="paramkey"></td> 353247738Sbapt <td></td> 354247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 355247738Sbapt <td class="paramname"> <em>anchor</em></td><td> </td> 356247738Sbapt </tr> 357247738Sbapt <tr> 358247738Sbapt <td></td> 359247738Sbapt <td>)</td> 360247738Sbapt <td></td><td></td><td></td> 361247738Sbapt </tr> 362247738Sbapt </table> 363247738Sbapt</div> 364247738Sbapt<div class="memdoc"> 365247738Sbapt 366247738Sbapt<p>Create an ALIAS event. </p> 367247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 368247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 369247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 370247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>anchor</em> </td><td>The anchor value.</td></tr> 371247738Sbapt </table> 372247738Sbapt </dd> 373247738Sbapt</dl> 374247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 375247738Sbapt 376247738Sbapt</div> 377247738Sbapt</div> 378247738Sbapt<a class="anchor" id="gafc60a1a437385e19e6fb3be075958c8c"></a><!-- doxytag: member="yaml.h::yaml_scalar_event_initialize" ref="gafc60a1a437385e19e6fb3be075958c8c" args="(yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, yaml_char_t *value, int length, int plain_implicit, int quoted_implicit, yaml_scalar_style_t style)" --> 379247738Sbapt<div class="memitem"> 380247738Sbapt<div class="memproto"> 381247738Sbapt <table class="memname"> 382247738Sbapt <tr> 383247738Sbapt <td class="memname">int yaml_scalar_event_initialize </td> 384247738Sbapt <td>(</td> 385247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 386247738Sbapt <td class="paramname"> <em>event</em>, </td> 387247738Sbapt </tr> 388247738Sbapt <tr> 389247738Sbapt <td class="paramkey"></td> 390247738Sbapt <td></td> 391247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 392247738Sbapt <td class="paramname"> <em>anchor</em>, </td> 393247738Sbapt </tr> 394247738Sbapt <tr> 395247738Sbapt <td class="paramkey"></td> 396247738Sbapt <td></td> 397247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 398247738Sbapt <td class="paramname"> <em>tag</em>, </td> 399247738Sbapt </tr> 400247738Sbapt <tr> 401247738Sbapt <td class="paramkey"></td> 402247738Sbapt <td></td> 403247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 404247738Sbapt <td class="paramname"> <em>value</em>, </td> 405247738Sbapt </tr> 406247738Sbapt <tr> 407247738Sbapt <td class="paramkey"></td> 408247738Sbapt <td></td> 409247738Sbapt <td class="paramtype">int </td> 410247738Sbapt <td class="paramname"> <em>length</em>, </td> 411247738Sbapt </tr> 412247738Sbapt <tr> 413247738Sbapt <td class="paramkey"></td> 414247738Sbapt <td></td> 415247738Sbapt <td class="paramtype">int </td> 416247738Sbapt <td class="paramname"> <em>plain_implicit</em>, </td> 417247738Sbapt </tr> 418247738Sbapt <tr> 419247738Sbapt <td class="paramkey"></td> 420247738Sbapt <td></td> 421247738Sbapt <td class="paramtype">int </td> 422247738Sbapt <td class="paramname"> <em>quoted_implicit</em>, </td> 423247738Sbapt </tr> 424247738Sbapt <tr> 425247738Sbapt <td class="paramkey"></td> 426247738Sbapt <td></td> 427247738Sbapt <td class="paramtype"><a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> </td> 428247738Sbapt <td class="paramname"> <em>style</em></td><td> </td> 429247738Sbapt </tr> 430247738Sbapt <tr> 431247738Sbapt <td></td> 432247738Sbapt <td>)</td> 433247738Sbapt <td></td><td></td><td></td> 434247738Sbapt </tr> 435247738Sbapt </table> 436247738Sbapt</div> 437247738Sbapt<div class="memdoc"> 438247738Sbapt 439247738Sbapt<p>Create a SCALAR event. </p> 440247738Sbapt<p>The <em>style</em> argument may be ignored by the emitter.</p> 441247738Sbapt<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> 442247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 443247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 444247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 445247738Sbapt <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> 446247738Sbapt <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> 447247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>value</em> </td><td>The scalar value. </td></tr> 448247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>The length of the scalar value. </td></tr> 449247738Sbapt <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> 450247738Sbapt <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> 451247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>style</em> </td><td>The scalar style.</td></tr> 452247738Sbapt </table> 453247738Sbapt </dd> 454247738Sbapt</dl> 455247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 456247738Sbapt 457247738Sbapt</div> 458247738Sbapt</div> 459247738Sbapt<a class="anchor" id="ga53aea428c768d7b131923d08c904b4eb"></a><!-- doxytag: member="yaml.h::yaml_sequence_start_event_initialize" ref="ga53aea428c768d7b131923d08c904b4eb" args="(yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_sequence_style_t style)" --> 460247738Sbapt<div class="memitem"> 461247738Sbapt<div class="memproto"> 462247738Sbapt <table class="memname"> 463247738Sbapt <tr> 464247738Sbapt <td class="memname">int yaml_sequence_start_event_initialize </td> 465247738Sbapt <td>(</td> 466247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 467247738Sbapt <td class="paramname"> <em>event</em>, </td> 468247738Sbapt </tr> 469247738Sbapt <tr> 470247738Sbapt <td class="paramkey"></td> 471247738Sbapt <td></td> 472247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 473247738Sbapt <td class="paramname"> <em>anchor</em>, </td> 474247738Sbapt </tr> 475247738Sbapt <tr> 476247738Sbapt <td class="paramkey"></td> 477247738Sbapt <td></td> 478247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 479247738Sbapt <td class="paramname"> <em>tag</em>, </td> 480247738Sbapt </tr> 481247738Sbapt <tr> 482247738Sbapt <td class="paramkey"></td> 483247738Sbapt <td></td> 484247738Sbapt <td class="paramtype">int </td> 485247738Sbapt <td class="paramname"> <em>implicit</em>, </td> 486247738Sbapt </tr> 487247738Sbapt <tr> 488247738Sbapt <td class="paramkey"></td> 489247738Sbapt <td></td> 490247738Sbapt <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> </td> 491247738Sbapt <td class="paramname"> <em>style</em></td><td> </td> 492247738Sbapt </tr> 493247738Sbapt <tr> 494247738Sbapt <td></td> 495247738Sbapt <td>)</td> 496247738Sbapt <td></td><td></td><td></td> 497247738Sbapt </tr> 498247738Sbapt </table> 499247738Sbapt</div> 500247738Sbapt<div class="memdoc"> 501247738Sbapt 502247738Sbapt<p>Create a SEQUENCE-START event. </p> 503247738Sbapt<p>The <em>style</em> argument may be ignored by the emitter.</p> 504247738Sbapt<p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p> 505247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 506247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 507247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 508247738Sbapt <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> 509247738Sbapt <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> 510247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>implicit</em> </td><td>If the tag may be omitted. </td></tr> 511247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>style</em> </td><td>The sequence style.</td></tr> 512247738Sbapt </table> 513247738Sbapt </dd> 514247738Sbapt</dl> 515247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 516247738Sbapt 517247738Sbapt</div> 518247738Sbapt</div> 519247738Sbapt<a class="anchor" id="ga99fdfa4b9d42b64d8171c9b22f334b1c"></a><!-- doxytag: member="yaml.h::yaml_sequence_end_event_initialize" ref="ga99fdfa4b9d42b64d8171c9b22f334b1c" args="(yaml_event_t *event)" --> 520247738Sbapt<div class="memitem"> 521247738Sbapt<div class="memproto"> 522247738Sbapt <table class="memname"> 523247738Sbapt <tr> 524247738Sbapt <td class="memname">int yaml_sequence_end_event_initialize </td> 525247738Sbapt <td>(</td> 526247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 527247738Sbapt <td class="paramname"> <em>event</em></td> 528247738Sbapt <td> ) </td> 529247738Sbapt <td></td> 530247738Sbapt </tr> 531247738Sbapt </table> 532247738Sbapt</div> 533247738Sbapt<div class="memdoc"> 534247738Sbapt 535247738Sbapt<p>Create a SEQUENCE-END event. </p> 536247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 537247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 538247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object.</td></tr> 539247738Sbapt </table> 540247738Sbapt </dd> 541247738Sbapt</dl> 542247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 543247738Sbapt 544247738Sbapt</div> 545247738Sbapt</div> 546247738Sbapt<a class="anchor" id="ga0603cf8d20f0b6dfc3be04b6360134aa"></a><!-- doxytag: member="yaml.h::yaml_mapping_start_event_initialize" ref="ga0603cf8d20f0b6dfc3be04b6360134aa" args="(yaml_event_t *event, yaml_char_t *anchor, yaml_char_t *tag, int implicit, yaml_mapping_style_t style)" --> 547247738Sbapt<div class="memitem"> 548247738Sbapt<div class="memproto"> 549247738Sbapt <table class="memname"> 550247738Sbapt <tr> 551247738Sbapt <td class="memname">int yaml_mapping_start_event_initialize </td> 552247738Sbapt <td>(</td> 553247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 554247738Sbapt <td class="paramname"> <em>event</em>, </td> 555247738Sbapt </tr> 556247738Sbapt <tr> 557247738Sbapt <td class="paramkey"></td> 558247738Sbapt <td></td> 559247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 560247738Sbapt <td class="paramname"> <em>anchor</em>, </td> 561247738Sbapt </tr> 562247738Sbapt <tr> 563247738Sbapt <td class="paramkey"></td> 564247738Sbapt <td></td> 565247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 566247738Sbapt <td class="paramname"> <em>tag</em>, </td> 567247738Sbapt </tr> 568247738Sbapt <tr> 569247738Sbapt <td class="paramkey"></td> 570247738Sbapt <td></td> 571247738Sbapt <td class="paramtype">int </td> 572247738Sbapt <td class="paramname"> <em>implicit</em>, </td> 573247738Sbapt </tr> 574247738Sbapt <tr> 575247738Sbapt <td class="paramkey"></td> 576247738Sbapt <td></td> 577247738Sbapt <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> </td> 578247738Sbapt <td class="paramname"> <em>style</em></td><td> </td> 579247738Sbapt </tr> 580247738Sbapt <tr> 581247738Sbapt <td></td> 582247738Sbapt <td>)</td> 583247738Sbapt <td></td><td></td><td></td> 584247738Sbapt </tr> 585247738Sbapt </table> 586247738Sbapt</div> 587247738Sbapt<div class="memdoc"> 588247738Sbapt 589247738Sbapt<p>Create a MAPPING-START event. </p> 590247738Sbapt<p>The <em>style</em> argument may be ignored by the emitter.</p> 591247738Sbapt<p>Either the <em>tag</em> attribute or the <em>implicit</em> flag must be set.</p> 592247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 593247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 594247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object. </td></tr> 595247738Sbapt <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> 596247738Sbapt <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> 597247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>implicit</em> </td><td>If the tag may be omitted. </td></tr> 598247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>style</em> </td><td>The mapping style.</td></tr> 599247738Sbapt </table> 600247738Sbapt </dd> 601247738Sbapt</dl> 602247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 603247738Sbapt 604247738Sbapt</div> 605247738Sbapt</div> 606247738Sbapt<a class="anchor" id="ga3afaf8b3aca2ec902a4e268f12adb0c2"></a><!-- doxytag: member="yaml.h::yaml_mapping_end_event_initialize" ref="ga3afaf8b3aca2ec902a4e268f12adb0c2" args="(yaml_event_t *event)" --> 607247738Sbapt<div class="memitem"> 608247738Sbapt<div class="memproto"> 609247738Sbapt <table class="memname"> 610247738Sbapt <tr> 611247738Sbapt <td class="memname">int yaml_mapping_end_event_initialize </td> 612247738Sbapt <td>(</td> 613247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 614247738Sbapt <td class="paramname"> <em>event</em></td> 615247738Sbapt <td> ) </td> 616247738Sbapt <td></td> 617247738Sbapt </tr> 618247738Sbapt </table> 619247738Sbapt</div> 620247738Sbapt<div class="memdoc"> 621247738Sbapt 622247738Sbapt<p>Create a MAPPING-END event. </p> 623247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 624247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 625247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>event</em> </td><td>An empty event object.</td></tr> 626247738Sbapt </table> 627247738Sbapt </dd> 628247738Sbapt</dl> 629247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 630247738Sbapt 631247738Sbapt</div> 632247738Sbapt</div> 633247738Sbapt<a class="anchor" id="ga5330d62ef52856aa53188137cb93a6a1"></a><!-- doxytag: member="yaml.h::yaml_event_delete" ref="ga5330d62ef52856aa53188137cb93a6a1" args="(yaml_event_t *event)" --> 634247738Sbapt<div class="memitem"> 635247738Sbapt<div class="memproto"> 636247738Sbapt <table class="memname"> 637247738Sbapt <tr> 638247738Sbapt <td class="memname">void yaml_event_delete </td> 639247738Sbapt <td>(</td> 640247738Sbapt <td class="paramtype"><a class="el" href="structyaml__event__s.html">yaml_event_t</a> * </td> 641247738Sbapt <td class="paramname"> <em>event</em></td> 642247738Sbapt <td> ) </td> 643247738Sbapt <td></td> 644247738Sbapt </tr> 645247738Sbapt </table> 646247738Sbapt</div> 647247738Sbapt<div class="memdoc"> 648247738Sbapt 649247738Sbapt<p>Free any memory allocated for an event object. </p> 650247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 651247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 652247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>event</em> </td><td>An event object. </td></tr> 653247738Sbapt </table> 654247738Sbapt </dd> 655247738Sbapt</dl> 656247738Sbapt 657247738Sbapt</div> 658247738Sbapt</div> 659247738Sbapt</div> 660247738Sbapt<hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by 661247738Sbapt<a href="http://www.doxygen.org/index.html"> 662247738Sbapt<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> 663247738Sbapt</body> 664247738Sbapt</html> 665
