mirror of
https://github.com/json-c/json-c.git
synced 2026-03-26 00:19:07 +08:00
Update docs for the 0.13.1 release.
This commit is contained in:
Eric Haszlakiewicz
@@ -3,8 +3,7 @@
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen 1.8.13"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<meta name="generator" content="Doxygen 1.8.8"/>
|
||||
<title>json-c: json_object_iterator.h File Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="jquery.js"></script>
|
||||
@@ -17,9 +16,9 @@
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<td id="projectalign" style="padding-left: 0.5em;">
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">json-c
|
||||
 <span id="projectnumber">0.13</span>
|
||||
 <span id="projectnumber">0.13.1</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -27,15 +26,21 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.13 -->
|
||||
<script type="text/javascript" src="menudata.js"></script>
|
||||
<script type="text/javascript" src="menu.js"></script>
|
||||
<script type="text/javascript">
|
||||
$(function() {
|
||||
initMenu('',false,false,'search.php','Search');
|
||||
});
|
||||
</script>
|
||||
<div id="main-nav"></div>
|
||||
<!-- Generated by Doxygen 1.8.8 -->
|
||||
<div id="navrow1" class="tabs">
|
||||
<ul class="tablist">
|
||||
<li><a href="index.html"><span>Main Page</span></a></li>
|
||||
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
||||
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
||||
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="navrow2" class="tabs2">
|
||||
<ul class="tablist">
|
||||
<li><a href="files.html"><span>File List</span></a></li>
|
||||
<li><a href="globals.html"><span>Globals</span></a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
@@ -82,9 +87,7 @@ Functions</h2></td></tr>
|
||||
<li>Reentrant: NO </li>
|
||||
</ul>
|
||||
</div><h2 class="groupheader">Function Documentation</h2>
|
||||
<a id="a925eb97b5aa5b64986a0f663f53cf0fa"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a925eb97b5aa5b64986a0f663f53cf0fa">◆ </a></span>json_object_iter_begin()</h2>
|
||||
|
||||
<a class="anchor" id="a925eb97b5aa5b64986a0f663f53cf0fa"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -106,12 +109,23 @@ Functions</h2></td></tr>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structjson__object__iterator.html">json_object_iterator</a> If the JSON Object has at least one pair, on return, the iterator refers to the first pair. If the JSON Object doesn't have any pairs, the returned iterator is equivalent to the "end" iterator for the same JSON Object instance.</dd></dl>
|
||||
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structjson__object__iterator.html">json_object_iterator</a> it;</div><div class="line"><span class="keyword">struct </span><a class="code" href="structjson__object__iterator.html">json_object_iterator</a> itEnd;</div><div class="line"><span class="keyword">struct </span><a class="code" href="structjson__object.html">json_object</a>* obj;</div><div class="line"></div><div class="line">obj = <a class="code" href="json__tokener_8h.html#a236ef64d079822a4411d13eae7190c4d">json_tokener_parse</a>(<span class="stringliteral">"{'first':'george', 'age':100}"</span>);</div><div class="line">it = <a class="code" href="json__object__iterator_8h.html#a925eb97b5aa5b64986a0f663f53cf0fa">json_object_iter_begin</a>(obj);</div><div class="line">itEnd = <a class="code" href="json__object__iterator_8h.html#a1fa3784395fb14496e3f1a1633028fd4">json_object_iter_end</a>(obj);</div><div class="line"></div><div class="line"><span class="keywordflow">while</span> (!<a class="code" href="json__object__iterator_8h.html#a878ca25f72b339882aa2607ac938e79c">json_object_iter_equal</a>(&it, &itEnd)) {</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>,</div><div class="line"> <a class="code" href="json__object__iterator_8h.html#af17775b9b812a4206a84e4d3fb5774ab">json_object_iter_peek_name</a>(&it));</div><div class="line"> <a class="code" href="json__object__iterator_8h.html#aa98a310c340f6d9b4eeecb673aa5e240">json_object_iter_next</a>(&it);</div><div class="line">}</div></div><!-- fragment -->
|
||||
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> struct json_object_iterator it;</div>
|
||||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> struct json_object_iterator itEnd;</div>
|
||||
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> struct json_object* obj;</div>
|
||||
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
|
||||
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> obj = json_tokener_parse("{'first':'george', 'age':100}");</div>
|
||||
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> it = json_object_iter_begin(obj);</div>
|
||||
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> itEnd = json_object_iter_end(obj);</div>
|
||||
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div>
|
||||
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> while (!json_object_iter_equal(&it, &itEnd)) {</div>
|
||||
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  printf("%s\n",</div>
|
||||
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  json_object_iter_peek_name(&it));</div>
|
||||
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  json_object_iter_next(&it);</div>
|
||||
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> }</div>
|
||||
</div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<a id="a1fa3784395fb14496e3f1a1633028fd4"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a1fa3784395fb14496e3f1a1633028fd4">◆ </a></span>json_object_iter_end()</h2>
|
||||
|
||||
<a class="anchor" id="a1fa3784395fb14496e3f1a1633028fd4"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -140,9 +154,7 @@ For performance reasons, memorize the "end" iterator prior to any loop.</dd></dl
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a878ca25f72b339882aa2607ac938e79c"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a878ca25f72b339882aa2607ac938e79c">◆ </a></span>json_object_iter_equal()</h2>
|
||||
|
||||
<a class="anchor" id="a878ca25f72b339882aa2607ac938e79c"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -179,9 +191,7 @@ For performance reasons, memorize the "end" iterator prior to any loop.</dd></dl
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="af30f56ca510d59da42e5592f9a436c10"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#af30f56ca510d59da42e5592f9a436c10">◆ </a></span>json_object_iter_init_default()</h2>
|
||||
|
||||
<a class="anchor" id="af30f56ca510d59da42e5592f9a436c10"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -195,16 +205,16 @@ For performance reasons, memorize the "end" iterator prior to any loop.</dd></dl
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<p>Initializes an iterator structure to a "default" value that is convenient for initializing an iterator variable to a default state (e.g., initialization list in a class' constructor).</p>
|
||||
<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structjson__object__iterator.html">json_object_iterator</a> iter = <a class="code" href="json__object__iterator_8h.html#af30f56ca510d59da42e5592f9a436c10">json_object_iter_init_default</a>();</div><div class="line">MyClass() : iter_(<a class="code" href="json__object__iterator_8h.html#af30f56ca510d59da42e5592f9a436c10">json_object_iter_init_default</a>())</div></div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>The initialized value doesn't reference any specific pair, is considered an invalid iterator, and MUST NOT be passed to any json-c API that expects a valid iterator.</dd>
|
||||
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> struct json_object_iterator iter = json_object_iter_init_default();</div>
|
||||
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> MyClass() : iter_(json_object_iter_init_default())</div>
|
||||
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>The initialized value doesn't reference any specific pair, is considered an invalid iterator, and MUST NOT be passed to any json-c API that expects a valid iterator.</dd>
|
||||
<dd>
|
||||
User and internal code MUST NOT make any assumptions about and dependencies on the value of the "default" iterator value.</dd></dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structjson__object__iterator.html">json_object_iterator</a> </dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="aa98a310c340f6d9b4eeecb673aa5e240"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aa98a310c340f6d9b4eeecb673aa5e240">◆ </a></span>json_object_iter_next()</h2>
|
||||
|
||||
<a class="anchor" id="aa98a310c340f6d9b4eeecb673aa5e240"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -228,9 +238,7 @@ User and internal code MUST NOT make any assumptions about and dependencies on t
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="af17775b9b812a4206a84e4d3fb5774ab"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#af17775b9b812a4206a84e4d3fb5774ab">◆ </a></span>json_object_iter_peek_name()</h2>
|
||||
|
||||
<a class="anchor" id="af17775b9b812a4206a84e4d3fb5774ab"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -255,9 +263,7 @@ User and internal code MUST NOT make any assumptions about and dependencies on t
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<a id="a47b0af7f1722c10475dffd29efc0b89d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a47b0af7f1722c10475dffd29efc0b89d">◆ </a></span>json_object_iter_peek_value()</h2>
|
||||
|
||||
<a class="anchor" id="a47b0af7f1722c10475dffd29efc0b89d"></a>
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
@@ -285,9 +291,9 @@ User and internal code MUST NOT make any assumptions about and dependencies on t
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated on Thu Dec 7 2017 18:06:04 for json-c by  <a href="http://www.doxygen.org/index.html">
|
||||
Generated on Mon Mar 5 2018 23:17:09 for json-c by  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||||
</a> 1.8.13
|
||||
</a> 1.8.8
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Reference in New Issue
Block a user