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: Nodes</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="#define-members">Defines</a> | 25247738Sbapt<a href="#typedef-members">Typedefs</a> | 26247738Sbapt<a href="#enum-members">Enumerations</a> | 27247738Sbapt<a href="#func-members">Functions</a> </div> 28247738Sbapt <div class="headertitle"> 29247738Sbapt<h1>Nodes</h1> </div> 30247738Sbapt</div> 31247738Sbapt<div class="contents"> 32247738Sbapt<table class="memberdecls"> 33247738Sbapt<tr><td colspan="2"><h2><a name="nested-classes"></a> 34247738SbaptData Structures</h2></td></tr> 35247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a></td></tr> 36247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">An element of a mapping node. <a href="structyaml__node__pair__s.html#_details">More...</a><br/></td></tr> 37247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__node__s.html">yaml_node_s</a></td></tr> 38247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The node structure. <a href="structyaml__node__s.html#_details">More...</a><br/></td></tr> 39247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structyaml__document__s.html">yaml_document_s</a></td></tr> 40247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The document structure. <a href="structyaml__document__s.html#_details">More...</a><br/></td></tr> 41247738Sbapt<tr><td colspan="2"><h2><a name="define-members"></a> 42247738SbaptDefines</h2></td></tr> 43247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gadfa882b6e42a3a993d12392d55260b00">YAML_NULL_TAG</a> "tag:yaml.org,2002:null"</td></tr> 44247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!null</code> with the only possible value: <code>null</code>. <a href="#gadfa882b6e42a3a993d12392d55260b00"></a><br/></td></tr> 45247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga312629a1f51e91b136352db988d4d771">YAML_BOOL_TAG</a> "tag:yaml.org,2002:bool"</td></tr> 46247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!bool</code> with the values: <code>true</code> and <code>falce</code>. <a href="#ga312629a1f51e91b136352db988d4d771"></a><br/></td></tr> 47247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gac5dbc6d1f556663edf8db88d6113e931">YAML_STR_TAG</a> "tag:yaml.org,2002:str"</td></tr> 48247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!str</code> for string values. <a href="#gac5dbc6d1f556663edf8db88d6113e931"></a><br/></td></tr> 49247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga83263cdb4ffa6ad2f7d9a87281979ff5">YAML_INT_TAG</a> "tag:yaml.org,2002:int"</td></tr> 50247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!int</code> for integer values. <a href="#ga83263cdb4ffa6ad2f7d9a87281979ff5"></a><br/></td></tr> 51247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga6ab2ec71fc47cb24f1003b9acdb92843">YAML_FLOAT_TAG</a> "tag:yaml.org,2002:float"</td></tr> 52247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!float</code> for float values. <a href="#ga6ab2ec71fc47cb24f1003b9acdb92843"></a><br/></td></tr> 53247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga3e27cca7191234f2e8c95eaf3bc99a73">YAML_TIMESTAMP_TAG</a> "tag:yaml.org,2002:timestamp"</td></tr> 54247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!timestamp</code> for date and time values. <a href="#ga3e27cca7191234f2e8c95eaf3bc99a73"></a><br/></td></tr> 55247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaa8284b30f9c9e3f10f6a69c9b882f417">YAML_SEQ_TAG</a> "tag:yaml.org,2002:seq"</td></tr> 56247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!seq</code> is used to denote sequences. <a href="#gaa8284b30f9c9e3f10f6a69c9b882f417"></a><br/></td></tr> 57247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga22ae99cf3ac014dd76873268fd068c12">YAML_MAP_TAG</a> "tag:yaml.org,2002:map"</td></tr> 58247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The tag <code>!!map</code> is used to denote mapping. <a href="#ga22ae99cf3ac014dd76873268fd068c12"></a><br/></td></tr> 59247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf6b0c4e819b8f6915515a4f70065aaaa">YAML_DEFAULT_SCALAR_TAG</a> YAML_STR_TAG</td></tr> 60247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The default scalar tag is <code>!!str</code>. <a href="#gaf6b0c4e819b8f6915515a4f70065aaaa"></a><br/></td></tr> 61247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf195b67002518702e27746d6b4da6124">YAML_DEFAULT_SEQUENCE_TAG</a> YAML_SEQ_TAG</td></tr> 62247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The default sequence tag is <code>!!seq</code>. <a href="#gaf195b67002518702e27746d6b4da6124"></a><br/></td></tr> 63247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gaf7b1f8f0ce5665794510cd3841802a5f">YAML_DEFAULT_MAPPING_TAG</a> YAML_MAP_TAG</td></tr> 64247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The default mapping tag is <code>!!map</code>. <a href="#gaf7b1f8f0ce5665794510cd3841802a5f"></a><br/></td></tr> 65247738Sbapt<tr><td colspan="2"><h2><a name="typedef-members"></a> 66247738SbaptTypedefs</h2></td></tr> 67247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td></tr> 68247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Node types. <a href="#gabe020d2fc42d3e896549e9f97da622d2"></a><br/></td></tr> 69247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga9eaaa233b120b9d9db47de93c294c40f">yaml_node_t</a></td></tr> 70247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The forward definition of a document node structure. <a href="#ga9eaaa233b120b9d9db47de93c294c40f"></a><br/></td></tr> 71247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td></tr> 72247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">An element of a sequence node. <a href="#ga7cc3581582e778b00c04e99cd3656860"></a><br/></td></tr> 73247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga90f1c8b83c5c38dc4016afc1cc2050c4">yaml_node_pair_t</a></td></tr> 74247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">An element of a mapping node. <a href="#ga90f1c8b83c5c38dc4016afc1cc2050c4"></a><br/></td></tr> 75247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gad94e064e95baeb22e4f7acc7804e8479">yaml_document_t</a></td></tr> 76247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">The document structure. <a href="#gad94e064e95baeb22e4f7acc7804e8479"></a><br/></td></tr> 77247738Sbapt<tr><td colspan="2"><h2><a name="enum-members"></a> 78247738SbaptEnumerations</h2></td></tr> 79247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> { <br/> 80247738Sbapt <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739">YAML_NO_NODE</a>, 81247738Sbapt<br/> 82247738Sbapt <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45">YAML_SCALAR_NODE</a>, 83247738Sbapt<br/> 84247738Sbapt <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15">YAML_SEQUENCE_NODE</a>, 85247738Sbapt<br/> 86247738Sbapt <a class="el" href="group__nodes.html#gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6">YAML_MAPPING_NODE</a> 87247738Sbapt<br/> 88247738Sbapt }</td></tr> 89247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Node types. </p> 90247738Sbapt <a href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">More...</a><br/></td></tr> 91247738Sbapt<tr><td colspan="2"><h2><a name="func-members"></a> 92247738SbaptFunctions</h2></td></tr> 93247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga62a485c96f3b7962436a0da5e6f3cc89">yaml_document_initialize</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <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 start_implicit, int end_implicit)</td></tr> 94247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a YAML document. <a href="#ga62a485c96f3b7962436a0da5e6f3cc89"></a><br/></td></tr> 95247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga2754b1544fb4e110e83fafbc708b0672">yaml_document_delete</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document)</td></tr> 96247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete a YAML document and all its nodes. <a href="#ga2754b1544fb4e110e83fafbc708b0672"></a><br/></td></tr> 97247738Sbapt<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__node__s.html">yaml_node_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#gafa1feabc9747dbded4dca24e27d3c21a">yaml_document_get_node</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, int index)</td></tr> 98247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a node of a YAML document. <a href="#gafa1feabc9747dbded4dca24e27d3c21a"></a><br/></td></tr> 99247738Sbapt<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structyaml__node__s.html">yaml_node_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga40eeaa68fb2f3be34c4fe34e7597d324">yaml_document_get_root_node</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document)</td></tr> 100247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the root of a YAML document node. <a href="#ga40eeaa68fb2f3be34c4fe34e7597d324"></a><br/></td></tr> 101247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga45dab8b983b58a005557d4b01f5057b0">yaml_document_add_scalar</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <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, <a class="el" href="group__styles.html#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_style_t</a> style)</td></tr> 102247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SCALAR node and attach it to the document. <a href="#ga45dab8b983b58a005557d4b01f5057b0"></a><br/></td></tr> 103247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga83b2f7fdd9a439397a42016bddad7786">yaml_document_add_sequence</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> style)</td></tr> 104247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a SEQUENCE node and attach it to the document. <a href="#ga83b2f7fdd9a439397a42016bddad7786"></a><br/></td></tr> 105247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga45a9f8288704f99cd81dc5cb31329d34">yaml_document_add_mapping</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, <a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> *tag, <a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> style)</td></tr> 106247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a MAPPING node and attach it to the document. <a href="#ga45a9f8288704f99cd81dc5cb31329d34"></a><br/></td></tr> 107247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga16435917cd6c0261cd390fa8cf173b1b">yaml_document_append_sequence_item</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, int sequence, int item)</td></tr> 108247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an item to a SEQUENCE node. <a href="#ga16435917cd6c0261cd390fa8cf173b1b"></a><br/></td></tr> 109247738Sbapt<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__nodes.html#ga2db27002d8a9ae06b1729d0ee06553d2">yaml_document_append_mapping_pair</a> (<a class="el" href="structyaml__document__s.html">yaml_document_t</a> *document, int mapping, int key, int value)</td></tr> 110247738Sbapt<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a pair of a key and a value to a MAPPING node. <a href="#ga2db27002d8a9ae06b1729d0ee06553d2"></a><br/></td></tr> 111247738Sbapt</table> 112247738Sbapt<hr/><h2>Define Documentation</h2> 113247738Sbapt<a class="anchor" id="gadfa882b6e42a3a993d12392d55260b00"></a><!-- doxytag: member="yaml.h::YAML_NULL_TAG" ref="gadfa882b6e42a3a993d12392d55260b00" args="" --> 114247738Sbapt<div class="memitem"> 115247738Sbapt<div class="memproto"> 116247738Sbapt <table class="memname"> 117247738Sbapt <tr> 118247738Sbapt <td class="memname">#define YAML_NULL_TAG "tag:yaml.org,2002:null"</td> 119247738Sbapt </tr> 120247738Sbapt </table> 121247738Sbapt</div> 122247738Sbapt<div class="memdoc"> 123247738Sbapt 124247738Sbapt<p>The tag <code>!!null</code> with the only possible value: <code>null</code>. </p> 125247738Sbapt 126247738Sbapt</div> 127247738Sbapt</div> 128247738Sbapt<a class="anchor" id="ga312629a1f51e91b136352db988d4d771"></a><!-- doxytag: member="yaml.h::YAML_BOOL_TAG" ref="ga312629a1f51e91b136352db988d4d771" args="" --> 129247738Sbapt<div class="memitem"> 130247738Sbapt<div class="memproto"> 131247738Sbapt <table class="memname"> 132247738Sbapt <tr> 133247738Sbapt <td class="memname">#define YAML_BOOL_TAG "tag:yaml.org,2002:bool"</td> 134247738Sbapt </tr> 135247738Sbapt </table> 136247738Sbapt</div> 137247738Sbapt<div class="memdoc"> 138247738Sbapt 139247738Sbapt<p>The tag <code>!!bool</code> with the values: <code>true</code> and <code>falce</code>. </p> 140247738Sbapt 141247738Sbapt</div> 142247738Sbapt</div> 143247738Sbapt<a class="anchor" id="gac5dbc6d1f556663edf8db88d6113e931"></a><!-- doxytag: member="yaml.h::YAML_STR_TAG" ref="gac5dbc6d1f556663edf8db88d6113e931" args="" --> 144247738Sbapt<div class="memitem"> 145247738Sbapt<div class="memproto"> 146247738Sbapt <table class="memname"> 147247738Sbapt <tr> 148247738Sbapt <td class="memname">#define YAML_STR_TAG "tag:yaml.org,2002:str"</td> 149247738Sbapt </tr> 150247738Sbapt </table> 151247738Sbapt</div> 152247738Sbapt<div class="memdoc"> 153247738Sbapt 154247738Sbapt<p>The tag <code>!!str</code> for string values. </p> 155247738Sbapt 156247738Sbapt</div> 157247738Sbapt</div> 158247738Sbapt<a class="anchor" id="ga83263cdb4ffa6ad2f7d9a87281979ff5"></a><!-- doxytag: member="yaml.h::YAML_INT_TAG" ref="ga83263cdb4ffa6ad2f7d9a87281979ff5" args="" --> 159247738Sbapt<div class="memitem"> 160247738Sbapt<div class="memproto"> 161247738Sbapt <table class="memname"> 162247738Sbapt <tr> 163247738Sbapt <td class="memname">#define YAML_INT_TAG "tag:yaml.org,2002:int"</td> 164247738Sbapt </tr> 165247738Sbapt </table> 166247738Sbapt</div> 167247738Sbapt<div class="memdoc"> 168247738Sbapt 169247738Sbapt<p>The tag <code>!!int</code> for integer values. </p> 170247738Sbapt 171247738Sbapt</div> 172247738Sbapt</div> 173247738Sbapt<a class="anchor" id="ga6ab2ec71fc47cb24f1003b9acdb92843"></a><!-- doxytag: member="yaml.h::YAML_FLOAT_TAG" ref="ga6ab2ec71fc47cb24f1003b9acdb92843" args="" --> 174247738Sbapt<div class="memitem"> 175247738Sbapt<div class="memproto"> 176247738Sbapt <table class="memname"> 177247738Sbapt <tr> 178247738Sbapt <td class="memname">#define YAML_FLOAT_TAG "tag:yaml.org,2002:float"</td> 179247738Sbapt </tr> 180247738Sbapt </table> 181247738Sbapt</div> 182247738Sbapt<div class="memdoc"> 183247738Sbapt 184247738Sbapt<p>The tag <code>!!float</code> for float values. </p> 185247738Sbapt 186247738Sbapt</div> 187247738Sbapt</div> 188247738Sbapt<a class="anchor" id="ga3e27cca7191234f2e8c95eaf3bc99a73"></a><!-- doxytag: member="yaml.h::YAML_TIMESTAMP_TAG" ref="ga3e27cca7191234f2e8c95eaf3bc99a73" args="" --> 189247738Sbapt<div class="memitem"> 190247738Sbapt<div class="memproto"> 191247738Sbapt <table class="memname"> 192247738Sbapt <tr> 193247738Sbapt <td class="memname">#define YAML_TIMESTAMP_TAG "tag:yaml.org,2002:timestamp"</td> 194247738Sbapt </tr> 195247738Sbapt </table> 196247738Sbapt</div> 197247738Sbapt<div class="memdoc"> 198247738Sbapt 199247738Sbapt<p>The tag <code>!!timestamp</code> for date and time values. </p> 200247738Sbapt 201247738Sbapt</div> 202247738Sbapt</div> 203247738Sbapt<a class="anchor" id="gaa8284b30f9c9e3f10f6a69c9b882f417"></a><!-- doxytag: member="yaml.h::YAML_SEQ_TAG" ref="gaa8284b30f9c9e3f10f6a69c9b882f417" args="" --> 204247738Sbapt<div class="memitem"> 205247738Sbapt<div class="memproto"> 206247738Sbapt <table class="memname"> 207247738Sbapt <tr> 208247738Sbapt <td class="memname">#define YAML_SEQ_TAG "tag:yaml.org,2002:seq"</td> 209247738Sbapt </tr> 210247738Sbapt </table> 211247738Sbapt</div> 212247738Sbapt<div class="memdoc"> 213247738Sbapt 214247738Sbapt<p>The tag <code>!!seq</code> is used to denote sequences. </p> 215247738Sbapt 216247738Sbapt</div> 217247738Sbapt</div> 218247738Sbapt<a class="anchor" id="ga22ae99cf3ac014dd76873268fd068c12"></a><!-- doxytag: member="yaml.h::YAML_MAP_TAG" ref="ga22ae99cf3ac014dd76873268fd068c12" args="" --> 219247738Sbapt<div class="memitem"> 220247738Sbapt<div class="memproto"> 221247738Sbapt <table class="memname"> 222247738Sbapt <tr> 223247738Sbapt <td class="memname">#define YAML_MAP_TAG "tag:yaml.org,2002:map"</td> 224247738Sbapt </tr> 225247738Sbapt </table> 226247738Sbapt</div> 227247738Sbapt<div class="memdoc"> 228247738Sbapt 229247738Sbapt<p>The tag <code>!!map</code> is used to denote mapping. </p> 230247738Sbapt 231247738Sbapt</div> 232247738Sbapt</div> 233247738Sbapt<a class="anchor" id="gaf6b0c4e819b8f6915515a4f70065aaaa"></a><!-- doxytag: member="yaml.h::YAML_DEFAULT_SCALAR_TAG" ref="gaf6b0c4e819b8f6915515a4f70065aaaa" args="" --> 234247738Sbapt<div class="memitem"> 235247738Sbapt<div class="memproto"> 236247738Sbapt <table class="memname"> 237247738Sbapt <tr> 238247738Sbapt <td class="memname">#define YAML_DEFAULT_SCALAR_TAG YAML_STR_TAG</td> 239247738Sbapt </tr> 240247738Sbapt </table> 241247738Sbapt</div> 242247738Sbapt<div class="memdoc"> 243247738Sbapt 244247738Sbapt<p>The default scalar tag is <code>!!str</code>. </p> 245247738Sbapt 246247738Sbapt</div> 247247738Sbapt</div> 248247738Sbapt<a class="anchor" id="gaf195b67002518702e27746d6b4da6124"></a><!-- doxytag: member="yaml.h::YAML_DEFAULT_SEQUENCE_TAG" ref="gaf195b67002518702e27746d6b4da6124" args="" --> 249247738Sbapt<div class="memitem"> 250247738Sbapt<div class="memproto"> 251247738Sbapt <table class="memname"> 252247738Sbapt <tr> 253247738Sbapt <td class="memname">#define YAML_DEFAULT_SEQUENCE_TAG YAML_SEQ_TAG</td> 254247738Sbapt </tr> 255247738Sbapt </table> 256247738Sbapt</div> 257247738Sbapt<div class="memdoc"> 258247738Sbapt 259247738Sbapt<p>The default sequence tag is <code>!!seq</code>. </p> 260247738Sbapt 261247738Sbapt</div> 262247738Sbapt</div> 263247738Sbapt<a class="anchor" id="gaf7b1f8f0ce5665794510cd3841802a5f"></a><!-- doxytag: member="yaml.h::YAML_DEFAULT_MAPPING_TAG" ref="gaf7b1f8f0ce5665794510cd3841802a5f" args="" --> 264247738Sbapt<div class="memitem"> 265247738Sbapt<div class="memproto"> 266247738Sbapt <table class="memname"> 267247738Sbapt <tr> 268247738Sbapt <td class="memname">#define YAML_DEFAULT_MAPPING_TAG YAML_MAP_TAG</td> 269247738Sbapt </tr> 270247738Sbapt </table> 271247738Sbapt</div> 272247738Sbapt<div class="memdoc"> 273247738Sbapt 274247738Sbapt<p>The default mapping tag is <code>!!map</code>. </p> 275247738Sbapt 276247738Sbapt</div> 277247738Sbapt</div> 278247738Sbapt<hr/><h2>Typedef Documentation</h2> 279247738Sbapt<a class="anchor" id="gabe020d2fc42d3e896549e9f97da622d2"></a><!-- doxytag: member="yaml.h::yaml_node_type_t" ref="gabe020d2fc42d3e896549e9f97da622d2" args="" --> 280247738Sbapt<div class="memitem"> 281247738Sbapt<div class="memproto"> 282247738Sbapt <table class="memname"> 283247738Sbapt <tr> 284247738Sbapt <td class="memname">typedef enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a> <a class="el" href="group__nodes.html#gabe020d2fc42d3e896549e9f97da622d2">yaml_node_type_t</a></td> 285247738Sbapt </tr> 286247738Sbapt </table> 287247738Sbapt</div> 288247738Sbapt<div class="memdoc"> 289247738Sbapt 290247738Sbapt<p>Node types. </p> 291247738Sbapt 292247738Sbapt</div> 293247738Sbapt</div> 294247738Sbapt<a class="anchor" id="ga9eaaa233b120b9d9db47de93c294c40f"></a><!-- doxytag: member="yaml.h::yaml_node_t" ref="ga9eaaa233b120b9d9db47de93c294c40f" args="" --> 295247738Sbapt<div class="memitem"> 296247738Sbapt<div class="memproto"> 297247738Sbapt <table class="memname"> 298247738Sbapt <tr> 299247738Sbapt <td class="memname">typedef struct <a class="el" href="structyaml__node__s.html">yaml_node_s</a> <a class="el" href="structyaml__node__s.html">yaml_node_t</a></td> 300247738Sbapt </tr> 301247738Sbapt </table> 302247738Sbapt</div> 303247738Sbapt<div class="memdoc"> 304247738Sbapt 305247738Sbapt<p>The forward definition of a document node structure. </p> 306247738Sbapt 307247738Sbapt</div> 308247738Sbapt</div> 309247738Sbapt<a class="anchor" id="ga7cc3581582e778b00c04e99cd3656860"></a><!-- doxytag: member="yaml.h::yaml_node_item_t" ref="ga7cc3581582e778b00c04e99cd3656860" args="" --> 310247738Sbapt<div class="memitem"> 311247738Sbapt<div class="memproto"> 312247738Sbapt <table class="memname"> 313247738Sbapt <tr> 314247738Sbapt <td class="memname">typedef int <a class="el" href="group__nodes.html#ga7cc3581582e778b00c04e99cd3656860">yaml_node_item_t</a></td> 315247738Sbapt </tr> 316247738Sbapt </table> 317247738Sbapt</div> 318247738Sbapt<div class="memdoc"> 319247738Sbapt 320247738Sbapt<p>An element of a sequence node. </p> 321247738Sbapt 322247738Sbapt</div> 323247738Sbapt</div> 324247738Sbapt<a class="anchor" id="ga90f1c8b83c5c38dc4016afc1cc2050c4"></a><!-- doxytag: member="yaml.h::yaml_node_pair_t" ref="ga90f1c8b83c5c38dc4016afc1cc2050c4" args="" --> 325247738Sbapt<div class="memitem"> 326247738Sbapt<div class="memproto"> 327247738Sbapt <table class="memname"> 328247738Sbapt <tr> 329247738Sbapt <td class="memname">typedef struct <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_s</a> <a class="el" href="structyaml__node__pair__s.html">yaml_node_pair_t</a></td> 330247738Sbapt </tr> 331247738Sbapt </table> 332247738Sbapt</div> 333247738Sbapt<div class="memdoc"> 334247738Sbapt 335247738Sbapt<p>An element of a mapping node. </p> 336247738Sbapt 337247738Sbapt</div> 338247738Sbapt</div> 339247738Sbapt<a class="anchor" id="gad94e064e95baeb22e4f7acc7804e8479"></a><!-- doxytag: member="yaml.h::yaml_document_t" ref="gad94e064e95baeb22e4f7acc7804e8479" args="" --> 340247738Sbapt<div class="memitem"> 341247738Sbapt<div class="memproto"> 342247738Sbapt <table class="memname"> 343247738Sbapt <tr> 344247738Sbapt <td class="memname">typedef struct <a class="el" href="structyaml__document__s.html">yaml_document_s</a> <a class="el" href="structyaml__document__s.html">yaml_document_t</a></td> 345247738Sbapt </tr> 346247738Sbapt </table> 347247738Sbapt</div> 348247738Sbapt<div class="memdoc"> 349247738Sbapt 350247738Sbapt<p>The document structure. </p> 351247738Sbapt 352247738Sbapt</div> 353247738Sbapt</div> 354247738Sbapt<hr/><h2>Enumeration Type Documentation</h2> 355247738Sbapt<a class="anchor" id="ga0897d4b6bdd1b56c7a5fa0ff17b4f798"></a><!-- doxytag: member="yaml.h::yaml_node_type_e" ref="ga0897d4b6bdd1b56c7a5fa0ff17b4f798" args="" --> 356247738Sbapt<div class="memitem"> 357247738Sbapt<div class="memproto"> 358247738Sbapt <table class="memname"> 359247738Sbapt <tr> 360247738Sbapt <td class="memname">enum <a class="el" href="group__nodes.html#ga0897d4b6bdd1b56c7a5fa0ff17b4f798">yaml_node_type_e</a></td> 361247738Sbapt </tr> 362247738Sbapt </table> 363247738Sbapt</div> 364247738Sbapt<div class="memdoc"> 365247738Sbapt 366247738Sbapt<p>Node types. </p> 367247738Sbapt<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0"> 368247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739"></a><!-- doxytag: member="YAML_NO_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a0fa87c0e89c4d4136cb47165e6917739" args="" -->YAML_NO_NODE</em> </td><td> 369247738Sbapt<p>An empty node. </p> 370247738Sbapt</td></tr> 371247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45"></a><!-- doxytag: member="YAML_SCALAR_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a413ec8ce6b728c9ace703d194b370a45" args="" -->YAML_SCALAR_NODE</em> </td><td> 372247738Sbapt<p>A scalar node. </p> 373247738Sbapt</td></tr> 374247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15"></a><!-- doxytag: member="YAML_SEQUENCE_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798a6c03b52f7ee737982eac5e4001faac15" args="" -->YAML_SEQUENCE_NODE</em> </td><td> 375247738Sbapt<p>A sequence node. </p> 376247738Sbapt</td></tr> 377247738Sbapt<tr><td valign="top"><em><a class="anchor" id="gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6"></a><!-- doxytag: member="YAML_MAPPING_NODE" ref="gga0897d4b6bdd1b56c7a5fa0ff17b4f798ac1a08580e3a70973583fc85e3e097ee6" args="" -->YAML_MAPPING_NODE</em> </td><td> 378247738Sbapt<p>A mapping node. </p> 379247738Sbapt</td></tr> 380247738Sbapt</table> 381247738Sbapt</dd> 382247738Sbapt</dl> 383247738Sbapt 384247738Sbapt</div> 385247738Sbapt</div> 386247738Sbapt<hr/><h2>Function Documentation</h2> 387247738Sbapt<a class="anchor" id="ga62a485c96f3b7962436a0da5e6f3cc89"></a><!-- doxytag: member="yaml.h::yaml_document_initialize" ref="ga62a485c96f3b7962436a0da5e6f3cc89" args="(yaml_document_t *document, yaml_version_directive_t *version_directive, yaml_tag_directive_t *tag_directives_start, yaml_tag_directive_t *tag_directives_end, int start_implicit, int end_implicit)" --> 388247738Sbapt<div class="memitem"> 389247738Sbapt<div class="memproto"> 390247738Sbapt <table class="memname"> 391247738Sbapt <tr> 392247738Sbapt <td class="memname">int yaml_document_initialize </td> 393247738Sbapt <td>(</td> 394247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 395247738Sbapt <td class="paramname"> <em>document</em>, </td> 396247738Sbapt </tr> 397247738Sbapt <tr> 398247738Sbapt <td class="paramkey"></td> 399247738Sbapt <td></td> 400247738Sbapt <td class="paramtype"><a class="el" href="structyaml__version__directive__s.html">yaml_version_directive_t</a> * </td> 401247738Sbapt <td class="paramname"> <em>version_directive</em>, </td> 402247738Sbapt </tr> 403247738Sbapt <tr> 404247738Sbapt <td class="paramkey"></td> 405247738Sbapt <td></td> 406247738Sbapt <td class="paramtype"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> * </td> 407247738Sbapt <td class="paramname"> <em>tag_directives_start</em>, </td> 408247738Sbapt </tr> 409247738Sbapt <tr> 410247738Sbapt <td class="paramkey"></td> 411247738Sbapt <td></td> 412247738Sbapt <td class="paramtype"><a class="el" href="structyaml__tag__directive__s.html">yaml_tag_directive_t</a> * </td> 413247738Sbapt <td class="paramname"> <em>tag_directives_end</em>, </td> 414247738Sbapt </tr> 415247738Sbapt <tr> 416247738Sbapt <td class="paramkey"></td> 417247738Sbapt <td></td> 418247738Sbapt <td class="paramtype">int </td> 419247738Sbapt <td class="paramname"> <em>start_implicit</em>, </td> 420247738Sbapt </tr> 421247738Sbapt <tr> 422247738Sbapt <td class="paramkey"></td> 423247738Sbapt <td></td> 424247738Sbapt <td class="paramtype">int </td> 425247738Sbapt <td class="paramname"> <em>end_implicit</em></td><td> </td> 426247738Sbapt </tr> 427247738Sbapt <tr> 428247738Sbapt <td></td> 429247738Sbapt <td>)</td> 430247738Sbapt <td></td><td></td><td></td> 431247738Sbapt </tr> 432247738Sbapt </table> 433247738Sbapt</div> 434247738Sbapt<div class="memdoc"> 435247738Sbapt 436247738Sbapt<p>Create a YAML document. </p> 437247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 438247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 439247738Sbapt <tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>document</em> </td><td>An empty document object. </td></tr> 440247738Sbapt <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> 441247738Sbapt <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> 442247738Sbapt <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> 443247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>start_implicit</em> </td><td>If the document start indicator is implicit. </td></tr> 444247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>end_implicit</em> </td><td>If the document end indicator is implicit.</td></tr> 445247738Sbapt </table> 446247738Sbapt </dd> 447247738Sbapt</dl> 448247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 449247738Sbapt 450247738Sbapt</div> 451247738Sbapt</div> 452247738Sbapt<a class="anchor" id="ga2754b1544fb4e110e83fafbc708b0672"></a><!-- doxytag: member="yaml.h::yaml_document_delete" ref="ga2754b1544fb4e110e83fafbc708b0672" args="(yaml_document_t *document)" --> 453247738Sbapt<div class="memitem"> 454247738Sbapt<div class="memproto"> 455247738Sbapt <table class="memname"> 456247738Sbapt <tr> 457247738Sbapt <td class="memname">void yaml_document_delete </td> 458247738Sbapt <td>(</td> 459247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 460247738Sbapt <td class="paramname"> <em>document</em></td> 461247738Sbapt <td> ) </td> 462247738Sbapt <td></td> 463247738Sbapt </tr> 464247738Sbapt </table> 465247738Sbapt</div> 466247738Sbapt<div class="memdoc"> 467247738Sbapt 468247738Sbapt<p>Delete a YAML document and all its nodes. </p> 469247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 470247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 471247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 472247738Sbapt </table> 473247738Sbapt </dd> 474247738Sbapt</dl> 475247738Sbapt 476247738Sbapt</div> 477247738Sbapt</div> 478247738Sbapt<a class="anchor" id="gafa1feabc9747dbded4dca24e27d3c21a"></a><!-- doxytag: member="yaml.h::yaml_document_get_node" ref="gafa1feabc9747dbded4dca24e27d3c21a" args="(yaml_document_t *document, int index)" --> 479247738Sbapt<div class="memitem"> 480247738Sbapt<div class="memproto"> 481247738Sbapt <table class="memname"> 482247738Sbapt <tr> 483247738Sbapt <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* yaml_document_get_node </td> 484247738Sbapt <td>(</td> 485247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 486247738Sbapt <td class="paramname"> <em>document</em>, </td> 487247738Sbapt </tr> 488247738Sbapt <tr> 489247738Sbapt <td class="paramkey"></td> 490247738Sbapt <td></td> 491247738Sbapt <td class="paramtype">int </td> 492247738Sbapt <td class="paramname"> <em>index</em></td><td> </td> 493247738Sbapt </tr> 494247738Sbapt <tr> 495247738Sbapt <td></td> 496247738Sbapt <td>)</td> 497247738Sbapt <td></td><td></td><td></td> 498247738Sbapt </tr> 499247738Sbapt </table> 500247738Sbapt</div> 501247738Sbapt<div class="memdoc"> 502247738Sbapt 503247738Sbapt<p>Get a node of a YAML document. </p> 504247738Sbapt<p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p> 505247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 506247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 507247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 508247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>index</em> </td><td>The node id.</td></tr> 509247738Sbapt </table> 510247738Sbapt </dd> 511247738Sbapt</dl> 512247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd>the node objct or <code>NULL</code> if <code>node_id</code> is out of range. </dd></dl> 513247738Sbapt 514247738Sbapt</div> 515247738Sbapt</div> 516247738Sbapt<a class="anchor" id="ga40eeaa68fb2f3be34c4fe34e7597d324"></a><!-- doxytag: member="yaml.h::yaml_document_get_root_node" ref="ga40eeaa68fb2f3be34c4fe34e7597d324" args="(yaml_document_t *document)" --> 517247738Sbapt<div class="memitem"> 518247738Sbapt<div class="memproto"> 519247738Sbapt <table class="memname"> 520247738Sbapt <tr> 521247738Sbapt <td class="memname"><a class="el" href="structyaml__node__s.html">yaml_node_t</a>* yaml_document_get_root_node </td> 522247738Sbapt <td>(</td> 523247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 524247738Sbapt <td class="paramname"> <em>document</em></td> 525247738Sbapt <td> ) </td> 526247738Sbapt <td></td> 527247738Sbapt </tr> 528247738Sbapt </table> 529247738Sbapt</div> 530247738Sbapt<div class="memdoc"> 531247738Sbapt 532247738Sbapt<p>Get the root of a YAML document node. </p> 533247738Sbapt<p>The root object is the first object added to the document.</p> 534247738Sbapt<p>The pointer returned by this function is valid until any of the functions modifying the documents are called.</p> 535247738Sbapt<p>An empty document produced by the parser signifies the end of a YAML stream.</p> 536247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 537247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 538247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>document</em> </td><td>A document object.</td></tr> 539247738Sbapt </table> 540247738Sbapt </dd> 541247738Sbapt</dl> 542247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd>the node object or <code>NULL</code> if the document is empty. </dd></dl> 543247738Sbapt 544247738Sbapt</div> 545247738Sbapt</div> 546247738Sbapt<a class="anchor" id="ga45dab8b983b58a005557d4b01f5057b0"></a><!-- doxytag: member="yaml.h::yaml_document_add_scalar" ref="ga45dab8b983b58a005557d4b01f5057b0" args="(yaml_document_t *document, yaml_char_t *tag, yaml_char_t *value, int length, yaml_scalar_style_t style)" --> 547247738Sbapt<div class="memitem"> 548247738Sbapt<div class="memproto"> 549247738Sbapt <table class="memname"> 550247738Sbapt <tr> 551247738Sbapt <td class="memname">int yaml_document_add_scalar </td> 552247738Sbapt <td>(</td> 553247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 554247738Sbapt <td class="paramname"> <em>document</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>tag</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>value</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>length</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#ga3fa6405631e1afe5bd5c488a6c5e8065">yaml_scalar_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 SCALAR node and attach it to the document. </p> 590247738Sbapt<p>The <em>style</em> argument may be ignored by the emitter.</p> 591247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 592247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 593247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 594247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>tag</em> </td><td>The scalar tag. </td></tr> 595247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>value</em> </td><td>The scalar value. </td></tr> 596247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>length</em> </td><td>The length of the scalar value. </td></tr> 597247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>style</em> </td><td>The scalar style.</td></tr> 598247738Sbapt </table> 599247738Sbapt </dd> 600247738Sbapt</dl> 601247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl> 602247738Sbapt 603247738Sbapt</div> 604247738Sbapt</div> 605247738Sbapt<a class="anchor" id="ga83b2f7fdd9a439397a42016bddad7786"></a><!-- doxytag: member="yaml.h::yaml_document_add_sequence" ref="ga83b2f7fdd9a439397a42016bddad7786" args="(yaml_document_t *document, yaml_char_t *tag, yaml_sequence_style_t style)" --> 606247738Sbapt<div class="memitem"> 607247738Sbapt<div class="memproto"> 608247738Sbapt <table class="memname"> 609247738Sbapt <tr> 610247738Sbapt <td class="memname">int yaml_document_add_sequence </td> 611247738Sbapt <td>(</td> 612247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 613247738Sbapt <td class="paramname"> <em>document</em>, </td> 614247738Sbapt </tr> 615247738Sbapt <tr> 616247738Sbapt <td class="paramkey"></td> 617247738Sbapt <td></td> 618247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 619247738Sbapt <td class="paramname"> <em>tag</em>, </td> 620247738Sbapt </tr> 621247738Sbapt <tr> 622247738Sbapt <td class="paramkey"></td> 623247738Sbapt <td></td> 624247738Sbapt <td class="paramtype"><a class="el" href="group__styles.html#ga58a1123d271e56c72de6abf852ac4dc2">yaml_sequence_style_t</a> </td> 625247738Sbapt <td class="paramname"> <em>style</em></td><td> </td> 626247738Sbapt </tr> 627247738Sbapt <tr> 628247738Sbapt <td></td> 629247738Sbapt <td>)</td> 630247738Sbapt <td></td><td></td><td></td> 631247738Sbapt </tr> 632247738Sbapt </table> 633247738Sbapt</div> 634247738Sbapt<div class="memdoc"> 635247738Sbapt 636247738Sbapt<p>Create a SEQUENCE node and attach it to the document. </p> 637247738Sbapt<p>The <em>style</em> argument may be ignored by the emitter.</p> 638247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 639247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 640247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 641247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>tag</em> </td><td>The sequence tag. </td></tr> 642247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>style</em> </td><td>The sequence style.</td></tr> 643247738Sbapt </table> 644247738Sbapt </dd> 645247738Sbapt</dl> 646247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl> 647247738Sbapt 648247738Sbapt</div> 649247738Sbapt</div> 650247738Sbapt<a class="anchor" id="ga45a9f8288704f99cd81dc5cb31329d34"></a><!-- doxytag: member="yaml.h::yaml_document_add_mapping" ref="ga45a9f8288704f99cd81dc5cb31329d34" args="(yaml_document_t *document, yaml_char_t *tag, yaml_mapping_style_t style)" --> 651247738Sbapt<div class="memitem"> 652247738Sbapt<div class="memproto"> 653247738Sbapt <table class="memname"> 654247738Sbapt <tr> 655247738Sbapt <td class="memname">int yaml_document_add_mapping </td> 656247738Sbapt <td>(</td> 657247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 658247738Sbapt <td class="paramname"> <em>document</em>, </td> 659247738Sbapt </tr> 660247738Sbapt <tr> 661247738Sbapt <td class="paramkey"></td> 662247738Sbapt <td></td> 663247738Sbapt <td class="paramtype"><a class="el" href="group__basic.html#gaf8657e81f0b8b05d1a081001fc6cb8bd">yaml_char_t</a> * </td> 664247738Sbapt <td class="paramname"> <em>tag</em>, </td> 665247738Sbapt </tr> 666247738Sbapt <tr> 667247738Sbapt <td class="paramkey"></td> 668247738Sbapt <td></td> 669247738Sbapt <td class="paramtype"><a class="el" href="group__styles.html#gab47523846a5c5960e07367a28ea9750a">yaml_mapping_style_t</a> </td> 670247738Sbapt <td class="paramname"> <em>style</em></td><td> </td> 671247738Sbapt </tr> 672247738Sbapt <tr> 673247738Sbapt <td></td> 674247738Sbapt <td>)</td> 675247738Sbapt <td></td><td></td><td></td> 676247738Sbapt </tr> 677247738Sbapt </table> 678247738Sbapt</div> 679247738Sbapt<div class="memdoc"> 680247738Sbapt 681247738Sbapt<p>Create a MAPPING node and attach it to the document. </p> 682247738Sbapt<p>The <em>style</em> argument may be ignored by the emitter.</p> 683247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 684247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 685247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 686247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>tag</em> </td><td>The sequence tag. </td></tr> 687247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>style</em> </td><td>The sequence style.</td></tr> 688247738Sbapt </table> 689247738Sbapt </dd> 690247738Sbapt</dl> 691247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd>the node id or <code>0</code> on error. </dd></dl> 692247738Sbapt 693247738Sbapt</div> 694247738Sbapt</div> 695247738Sbapt<a class="anchor" id="ga16435917cd6c0261cd390fa8cf173b1b"></a><!-- doxytag: member="yaml.h::yaml_document_append_sequence_item" ref="ga16435917cd6c0261cd390fa8cf173b1b" args="(yaml_document_t *document, int sequence, int item)" --> 696247738Sbapt<div class="memitem"> 697247738Sbapt<div class="memproto"> 698247738Sbapt <table class="memname"> 699247738Sbapt <tr> 700247738Sbapt <td class="memname">int yaml_document_append_sequence_item </td> 701247738Sbapt <td>(</td> 702247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 703247738Sbapt <td class="paramname"> <em>document</em>, </td> 704247738Sbapt </tr> 705247738Sbapt <tr> 706247738Sbapt <td class="paramkey"></td> 707247738Sbapt <td></td> 708247738Sbapt <td class="paramtype">int </td> 709247738Sbapt <td class="paramname"> <em>sequence</em>, </td> 710247738Sbapt </tr> 711247738Sbapt <tr> 712247738Sbapt <td class="paramkey"></td> 713247738Sbapt <td></td> 714247738Sbapt <td class="paramtype">int </td> 715247738Sbapt <td class="paramname"> <em>item</em></td><td> </td> 716247738Sbapt </tr> 717247738Sbapt <tr> 718247738Sbapt <td></td> 719247738Sbapt <td>)</td> 720247738Sbapt <td></td><td></td><td></td> 721247738Sbapt </tr> 722247738Sbapt </table> 723247738Sbapt</div> 724247738Sbapt<div class="memdoc"> 725247738Sbapt 726247738Sbapt<p>Add an item to a SEQUENCE node. </p> 727247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 728247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 729247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 730247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>sequence</em> </td><td>The sequence node id. </td></tr> 731247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>item</em> </td><td>The item node id.</td></tr> 732247738Sbapt </table> 733247738Sbapt </dd> 734247738Sbapt</dl> 735247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 736247738Sbapt 737247738Sbapt</div> 738247738Sbapt</div> 739247738Sbapt<a class="anchor" id="ga2db27002d8a9ae06b1729d0ee06553d2"></a><!-- doxytag: member="yaml.h::yaml_document_append_mapping_pair" ref="ga2db27002d8a9ae06b1729d0ee06553d2" args="(yaml_document_t *document, int mapping, int key, int value)" --> 740247738Sbapt<div class="memitem"> 741247738Sbapt<div class="memproto"> 742247738Sbapt <table class="memname"> 743247738Sbapt <tr> 744247738Sbapt <td class="memname">int yaml_document_append_mapping_pair </td> 745247738Sbapt <td>(</td> 746247738Sbapt <td class="paramtype"><a class="el" href="structyaml__document__s.html">yaml_document_t</a> * </td> 747247738Sbapt <td class="paramname"> <em>document</em>, </td> 748247738Sbapt </tr> 749247738Sbapt <tr> 750247738Sbapt <td class="paramkey"></td> 751247738Sbapt <td></td> 752247738Sbapt <td class="paramtype">int </td> 753247738Sbapt <td class="paramname"> <em>mapping</em>, </td> 754247738Sbapt </tr> 755247738Sbapt <tr> 756247738Sbapt <td class="paramkey"></td> 757247738Sbapt <td></td> 758247738Sbapt <td class="paramtype">int </td> 759247738Sbapt <td class="paramname"> <em>key</em>, </td> 760247738Sbapt </tr> 761247738Sbapt <tr> 762247738Sbapt <td class="paramkey"></td> 763247738Sbapt <td></td> 764247738Sbapt <td class="paramtype">int </td> 765247738Sbapt <td class="paramname"> <em>value</em></td><td> </td> 766247738Sbapt </tr> 767247738Sbapt <tr> 768247738Sbapt <td></td> 769247738Sbapt <td>)</td> 770247738Sbapt <td></td><td></td><td></td> 771247738Sbapt </tr> 772247738Sbapt </table> 773247738Sbapt</div> 774247738Sbapt<div class="memdoc"> 775247738Sbapt 776247738Sbapt<p>Add a pair of a key and a value to a MAPPING node. </p> 777247738Sbapt<dl><dt><b>Parameters:</b></dt><dd> 778247738Sbapt <table border="0" cellspacing="2" cellpadding="0"> 779247738Sbapt <tr><td valign="top"><tt>[in,out]</tt> </td><td valign="top"><em>document</em> </td><td>A document object. </td></tr> 780247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>mapping</em> </td><td>The mapping node id. </td></tr> 781247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>key</em> </td><td>The key node id. </td></tr> 782247738Sbapt <tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>value</em> </td><td>The value node id.</td></tr> 783247738Sbapt </table> 784247738Sbapt </dd> 785247738Sbapt</dl> 786247738Sbapt<dl class="return"><dt><b>Returns:</b></dt><dd><code>1</code> if the function succeeded, <code>0</code> on error. </dd></dl> 787247738Sbapt 788247738Sbapt</div> 789247738Sbapt</div> 790247738Sbapt</div> 791247738Sbapt<hr class="footer"/><address class="footer"><small>Generated on Mon May 30 2011 22:00:00 for yaml by 792247738Sbapt<a href="http://www.doxygen.org/index.html"> 793247738Sbapt<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address> 794247738Sbapt</body> 795247738Sbapt</html> 796
