Initial Import
[profile/ivi/json-glib.git] / doc / reference / html / json-glib-JSON-Array.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>JSON Array</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="JSON-GLib Reference Manual">
8 <link rel="up" href="ch01.html" title="Data Types">
9 <link rel="prev" href="json-glib-JSON-Node.html" title="JSON Node">
10 <link rel="next" href="json-glib-JSON-Object.html" title="JSON Object">
11 <meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="json-glib-JSON-Node.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">JSON-GLib Reference Manual</th>
21 <td><a accesskey="n" href="json-glib-JSON-Object.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#json-glib-JSON-Array.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#json-glib-JSON-Array.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="json-glib-JSON-Array"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="json-glib-JSON-Array.top_of_page"></a>JSON Array</span></h2>
34 <p>JSON Array — a JSON array representation</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="json-glib-JSON-Array.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">                    <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray">JsonArray</a>;
41 <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         <a class="link" href="json-glib-JSON-Array.html#json-array-new" title="json_array_new ()">json_array_new</a>                      (<em class="parameter"><code><span class="type">void</span></code></em>);
42 <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         <a class="link" href="json-glib-JSON-Array.html#json-array-sized-new" title="json_array_sized_new ()">json_array_sized_new</a>                (<em class="parameter"><code><span class="type">guint</span> n_elements</code></em>);
43 <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         <a class="link" href="json-glib-JSON-Array.html#json-array-ref" title="json_array_ref ()">json_array_ref</a>                      (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);
44 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-unref" title="json_array_unref ()">json_array_unref</a>                    (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);
45
46 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()">json_array_add_element</a>              (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
47                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> *node</code></em>);
48 <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="returnvalue">JsonNode</span></a> *          <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()">json_array_get_element</a>              (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
49                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
50 <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="returnvalue">JsonNode</span></a> *          <a class="link" href="json-glib-JSON-Array.html#json-array-dup-element" title="json_array_dup_element ()">json_array_dup_element</a>              (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
51                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
52 <span class="returnvalue">GList</span> *             <a class="link" href="json-glib-JSON-Array.html#json-array-get-elements" title="json_array_get_elements ()">json_array_get_elements</a>             (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);
53 <span class="returnvalue">guint</span>               <a class="link" href="json-glib-JSON-Array.html#json-array-get-length" title="json_array_get_length ()">json_array_get_length</a>               (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);
54 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-remove-element" title="json_array_remove_element ()">json_array_remove_element</a>           (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
55                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
56 <span class="returnvalue">void</span>                (<a class="link" href="json-glib-JSON-Array.html#JsonArrayForeach" title="JsonArrayForeach ()">*JsonArrayForeach</a>)                 (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
57                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>,
58                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> *element_node</code></em>,
59                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
60 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-foreach-element" title="json_array_foreach_element ()">json_array_foreach_element</a>          (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
61                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArrayForeach" title="JsonArrayForeach ()"><span class="type">JsonArrayForeach</span></a> func</code></em>,
62                                                          <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
63
64 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-array-element" title="json_array_add_array_element ()">json_array_add_array_element</a>        (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
65                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *value</code></em>);
66 <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         <a class="link" href="json-glib-JSON-Array.html#json-array-get-array-element" title="json_array_get_array_element ()">json_array_get_array_element</a>        (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
67                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
68 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-boolean-element" title="json_array_add_boolean_element ()">json_array_add_boolean_element</a>      (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
69                                                          <em class="parameter"><code><span class="type">gboolean</span> value</code></em>);
70 <span class="returnvalue">gboolean</span>            <a class="link" href="json-glib-JSON-Array.html#json-array-get-boolean-element" title="json_array_get_boolean_element ()">json_array_get_boolean_element</a>      (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
71                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
72 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-double-element" title="json_array_add_double_element ()">json_array_add_double_element</a>       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
73                                                          <em class="parameter"><code><span class="type">gdouble</span> value</code></em>);
74 <span class="returnvalue">gdouble</span>             <a class="link" href="json-glib-JSON-Array.html#json-array-get-double-element" title="json_array_get_double_element ()">json_array_get_double_element</a>       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
75                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
76 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-int-element" title="json_array_add_int_element ()">json_array_add_int_element</a>          (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
77                                                          <em class="parameter"><code><span class="type">gint64</span> value</code></em>);
78 <span class="returnvalue">gint64</span>              <a class="link" href="json-glib-JSON-Array.html#json-array-get-int-element" title="json_array_get_int_element ()">json_array_get_int_element</a>          (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
79                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
80 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-null-element" title="json_array_add_null_element ()">json_array_add_null_element</a>         (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);
81 <span class="returnvalue">gboolean</span>            <a class="link" href="json-glib-JSON-Array.html#json-array-get-null-element" title="json_array_get_null_element ()">json_array_get_null_element</a>         (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
82                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
83 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-object-element" title="json_array_add_object_element ()">json_array_add_object_element</a>       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
84                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="type">JsonObject</span></a> *value</code></em>);
85 <a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="returnvalue">JsonObject</span></a> *        <a class="link" href="json-glib-JSON-Array.html#json-array-get-object-element" title="json_array_get_object_element ()">json_array_get_object_element</a>       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
86                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
87 <span class="returnvalue">void</span>                <a class="link" href="json-glib-JSON-Array.html#json-array-add-string-element" title="json_array_add_string_element ()">json_array_add_string_element</a>       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
88                                                          <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);
89 const <span class="returnvalue">gchar</span> *       <a class="link" href="json-glib-JSON-Array.html#json-array-get-string-element" title="json_array_get_string_element ()">json_array_get_string_element</a>       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
90                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);
91 </pre>
92 </div>
93 <div class="refsect1">
94 <a name="json-glib-JSON-Array.description"></a><h2>Description</h2>
95 <p>
96 <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> is the representation of the array type inside JSON. It contains
97 <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a>s, which may contain fundamental types, other arrays or
98 objects.
99 </p>
100 <p>
101 Since arrays can be expensive, they are reference counted. You can control
102 the lifetime of a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> using <a class="link" href="json-glib-JSON-Array.html#json-array-ref" title="json_array_ref ()"><code class="function">json_array_ref()</code></a> and <a class="link" href="json-glib-JSON-Array.html#json-array-unref" title="json_array_unref ()"><code class="function">json_array_unref()</code></a>.
103 </p>
104 <p>
105 To append an element, use <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>.
106 To extract an element at a given index, use <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>.
107 To retrieve the entire array in list form, use <a class="link" href="json-glib-JSON-Array.html#json-array-get-elements" title="json_array_get_elements ()"><code class="function">json_array_get_elements()</code></a>.
108 To retrieve the length of the array, use <a class="link" href="json-glib-JSON-Array.html#json-array-get-length" title="json_array_get_length ()"><code class="function">json_array_get_length()</code></a>.
109 </p>
110 </div>
111 <div class="refsect1">
112 <a name="json-glib-JSON-Array.details"></a><h2>Details</h2>
113 <div class="refsect2">
114 <a name="JsonArray"></a><h3>JsonArray</h3>
115 <pre class="programlisting">typedef struct _JsonArray JsonArray;</pre>
116 <p>
117 A JSON array type. The contents of the <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> structure are private
118 and should only be accessed by the provided API
119 </p>
120 </div>
121 <hr>
122 <div class="refsect2">
123 <a name="json-array-new"></a><h3>json_array_new ()</h3>
124 <pre class="programlisting"><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         json_array_new                      (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
125 <p>
126 Creates a new <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>.
127 </p>
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
130 <tbody><tr>
131 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
132 <td>the newly created <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
133 </td>
134 </tr></tbody>
135 </table></div>
136 </div>
137 <hr>
138 <div class="refsect2">
139 <a name="json-array-sized-new"></a><h3>json_array_sized_new ()</h3>
140 <pre class="programlisting"><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         json_array_sized_new                (<em class="parameter"><code><span class="type">guint</span> n_elements</code></em>);</pre>
141 <p>
142 Creates a new <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> with <em class="parameter"><code>n_elements</code></em> slots already allocated.
143 </p>
144 <div class="variablelist"><table border="0">
145 <col align="left" valign="top">
146 <tbody>
147 <tr>
148 <td><p><span class="term"><em class="parameter"><code>n_elements</code></em> :</span></p></td>
149 <td>number of slots to pre-allocate</td>
150 </tr>
151 <tr>
152 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
153 <td>the newly created <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
154 </td>
155 </tr>
156 </tbody>
157 </table></div>
158 </div>
159 <hr>
160 <div class="refsect2">
161 <a name="json-array-ref"></a><h3>json_array_ref ()</h3>
162 <pre class="programlisting"><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         json_array_ref                      (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);</pre>
163 <p>
164 Increase by one the reference count of a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>.
165 </p>
166 <div class="variablelist"><table border="0">
167 <col align="left" valign="top">
168 <tbody>
169 <tr>
170 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
171 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
172 </td>
173 </tr>
174 <tr>
175 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
176 <td>the passed <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>, with the reference count
177 increased by one.</td>
178 </tr>
179 </tbody>
180 </table></div>
181 </div>
182 <hr>
183 <div class="refsect2">
184 <a name="json-array-unref"></a><h3>json_array_unref ()</h3>
185 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_unref                    (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);</pre>
186 <p>
187 Decreases by one the reference count of a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>. If the
188 reference count reaches zero, the array is destroyed and all
189 its allocated resources are freed.
190 </p>
191 <div class="variablelist"><table border="0">
192 <col align="left" valign="top">
193 <tbody><tr>
194 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
195 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
196 </td>
197 </tr></tbody>
198 </table></div>
199 </div>
200 <hr>
201 <div class="refsect2">
202 <a name="json-array-add-element"></a><h3>json_array_add_element ()</h3>
203 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_element              (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
204                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> *node</code></em>);</pre>
205 <p>
206 Appends <em class="parameter"><code>node</code></em> inside <em class="parameter"><code>array</code></em>. The array will take ownership of the
207 <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a>.
208 </p>
209 <div class="variablelist"><table border="0">
210 <col align="left" valign="top">
211 <tbody>
212 <tr>
213 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
214 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
215 </td>
216 </tr>
217 <tr>
218 <td><p><span class="term"><em class="parameter"><code>node</code></em> :</span></p></td>
219 <td>a <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
220 </td>
221 </tr>
222 </tbody>
223 </table></div>
224 </div>
225 <hr>
226 <div class="refsect2">
227 <a name="json-array-get-element"></a><h3>json_array_get_element ()</h3>
228 <pre class="programlisting"><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="returnvalue">JsonNode</span></a> *          json_array_get_element              (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
229                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
230 <p>
231 Retrieves the <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> containing the value of the element at <em class="parameter"><code>index_</code></em>
232 inside a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>.
233 </p>
234 <div class="variablelist"><table border="0">
235 <col align="left" valign="top">
236 <tbody>
237 <tr>
238 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
239 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
240 </td>
241 </tr>
242 <tr>
243 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
244 <td>the index of the element to retrieve</td>
245 </tr>
246 <tr>
247 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
248 <td>a pointer to the <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> at the requested index. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
249 </td>
250 </tr>
251 </tbody>
252 </table></div>
253 </div>
254 <hr>
255 <div class="refsect2">
256 <a name="json-array-dup-element"></a><h3>json_array_dup_element ()</h3>
257 <pre class="programlisting"><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="returnvalue">JsonNode</span></a> *          json_array_dup_element              (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
258                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
259 <p>
260 Retrieves a copy of the <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> containing the value of the
261 element at <em class="parameter"><code>index_</code></em> inside a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
262 </p>
263 <div class="variablelist"><table border="0">
264 <col align="left" valign="top">
265 <tbody>
266 <tr>
267 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
268 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
269 </td>
270 </tr>
271 <tr>
272 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
273 <td>the index of the element to retrieve</td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
277 <td>a copy of the <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> at the requested
278 index. Use <a class="link" href="json-glib-JSON-Node.html#json-node-free" title="json_node_free ()"><code class="function">json_node_free()</code></a> when done. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
279 </td>
280 </tr>
281 </tbody>
282 </table></div>
283 <p class="since">Since 0.6</p>
284 </div>
285 <hr>
286 <div class="refsect2">
287 <a name="json-array-get-elements"></a><h3>json_array_get_elements ()</h3>
288 <pre class="programlisting"><span class="returnvalue">GList</span> *             json_array_get_elements             (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);</pre>
289 <p>
290 Gets the elements of a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> as a list of <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a>s.
291 </p>
292 <div class="variablelist"><table border="0">
293 <col align="left" valign="top">
294 <tbody>
295 <tr>
296 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
297 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
298 </td>
299 </tr>
300 <tr>
301 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
302 <td>a <span class="type">GList</span>
303 containing the elements of the array. The contents of the list are
304 owned by the array and should never be modified or freed. Use
305 <code class="function">g_list_free()</code> on the returned list when done using it. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> JsonNode][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span>
306 </td>
307 </tr>
308 </tbody>
309 </table></div>
310 </div>
311 <hr>
312 <div class="refsect2">
313 <a name="json-array-get-length"></a><h3>json_array_get_length ()</h3>
314 <pre class="programlisting"><span class="returnvalue">guint</span>               json_array_get_length               (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);</pre>
315 <p>
316 Retrieves the length of a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
317 </p>
318 <div class="variablelist"><table border="0">
319 <col align="left" valign="top">
320 <tbody>
321 <tr>
322 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
323 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
324 </td>
325 </tr>
326 <tr>
327 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
328 <td>the length of the array</td>
329 </tr>
330 </tbody>
331 </table></div>
332 </div>
333 <hr>
334 <div class="refsect2">
335 <a name="json-array-remove-element"></a><h3>json_array_remove_element ()</h3>
336 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_remove_element           (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
337                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
338 <p>
339 Removes the <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> inside <em class="parameter"><code>array</code></em> at <em class="parameter"><code>index_</code></em> freeing its allocated
340 resources.
341 </p>
342 <div class="variablelist"><table border="0">
343 <col align="left" valign="top">
344 <tbody>
345 <tr>
346 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
347 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
348 </td>
349 </tr>
350 <tr>
351 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
352 <td>the position of the element to be removed</td>
353 </tr>
354 </tbody>
355 </table></div>
356 </div>
357 <hr>
358 <div class="refsect2">
359 <a name="JsonArrayForeach"></a><h3>JsonArrayForeach ()</h3>
360 <pre class="programlisting"><span class="returnvalue">void</span>                (*JsonArrayForeach)                 (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
361                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>,
362                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> *element_node</code></em>,
363                                                          <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
364 <p>
365 The function to be passed to <a class="link" href="json-glib-JSON-Array.html#json-array-foreach-element" title="json_array_foreach_element ()"><code class="function">json_array_foreach_element()</code></a>. You
366 should not add or remove elements to and from <em class="parameter"><code>array</code></em> within
367 this function. It is safe to change the value of <em class="parameter"><code>element_node</code></em>.
368 </p>
369 <div class="variablelist"><table border="0">
370 <col align="left" valign="top">
371 <tbody>
372 <tr>
373 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
374 <td>the iterated <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
375 </td>
376 </tr>
377 <tr>
378 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
379 <td>the index of the element</td>
380 </tr>
381 <tr>
382 <td><p><span class="term"><em class="parameter"><code>element_node</code></em> :</span></p></td>
383 <td>a <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> containing the value at <em class="parameter"><code>index_</code></em>
384 </td>
385 </tr>
386 <tr>
387 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
388 <td>data passed to the function</td>
389 </tr>
390 </tbody>
391 </table></div>
392 <p class="since">Since 0.8</p>
393 </div>
394 <hr>
395 <div class="refsect2">
396 <a name="json-array-foreach-element"></a><h3>json_array_foreach_element ()</h3>
397 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_foreach_element          (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
398                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArrayForeach" title="JsonArrayForeach ()"><span class="type">JsonArrayForeach</span></a> func</code></em>,
399                                                          <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
400 <p>
401 Iterates over all elements of <em class="parameter"><code>array</code></em> and calls <em class="parameter"><code>func</code></em> on
402 each one of them.
403 </p>
404 <p>
405 It is safe to change the value of a <a class="link" href="json-glib-JSON-Node.html#JsonNode" title="JsonNode"><span class="type">JsonNode</span></a> of the <em class="parameter"><code>array</code></em>
406 from within the iterator <em class="parameter"><code>func</code></em>, but it is not safe to add or
407 remove elements from the <em class="parameter"><code>array</code></em>.
408 </p>
409 <div class="variablelist"><table border="0">
410 <col align="left" valign="top">
411 <tbody>
412 <tr>
413 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
414 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
415 </td>
416 </tr>
417 <tr>
418 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
419 <td>the function to be called on each element. <span class="annotation">[<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>]</span>
420 </td>
421 </tr>
422 <tr>
423 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
424 <td>data to be passed to the function. <span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span>
425 </td>
426 </tr>
427 </tbody>
428 </table></div>
429 <p class="since">Since 0.8</p>
430 </div>
431 <hr>
432 <div class="refsect2">
433 <a name="json-array-add-array-element"></a><h3>json_array_add_array_element ()</h3>
434 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_array_element        (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
435                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *value</code></em>);</pre>
436 <p>
437 Conveniently adds an array into <em class="parameter"><code>array</code></em>. The <em class="parameter"><code>array</code></em> takes ownership
438 of the newly added <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
439 </p>
440 <p>
441 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-take-array" title="json_node_take_array ()"><code class="function">json_node_take_array()</code></a>
442 </p>
443 <div class="variablelist"><table border="0">
444 <col align="left" valign="top">
445 <tbody>
446 <tr>
447 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
448 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
449 </td>
450 </tr>
451 <tr>
452 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
453 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
454 </td>
455 </tr>
456 </tbody>
457 </table></div>
458 <p class="since">Since 0.8</p>
459 </div>
460 <hr>
461 <div class="refsect2">
462 <a name="json-array-get-array-element"></a><h3>json_array_get_array_element ()</h3>
463 <pre class="programlisting"><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="returnvalue">JsonArray</span></a> *         json_array_get_array_element        (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
464                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
465 <p>
466 Conveniently retrieves the array from the element at <em class="parameter"><code>index_</code></em>
467 inside <em class="parameter"><code>array</code></em>
468 </p>
469 <p>
470 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-get-array" title="json_node_get_array ()"><code class="function">json_node_get_array()</code></a>
471 </p>
472 <div class="variablelist"><table border="0">
473 <col align="left" valign="top">
474 <tbody>
475 <tr>
476 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
477 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
478 </td>
479 </tr>
480 <tr>
481 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
482 <td>the index of the element to retrieve</td>
483 </tr>
484 <tr>
485 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
486 <td>the array. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
487 </td>
488 </tr>
489 </tbody>
490 </table></div>
491 <p class="since">Since 0.8</p>
492 </div>
493 <hr>
494 <div class="refsect2">
495 <a name="json-array-add-boolean-element"></a><h3>json_array_add_boolean_element ()</h3>
496 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_boolean_element      (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
497                                                          <em class="parameter"><code><span class="type">gboolean</span> value</code></em>);</pre>
498 <p>
499 Conveniently adds a boolean <em class="parameter"><code>value</code></em> into <em class="parameter"><code>array</code></em>
500 </p>
501 <p>
502 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-set-boolean" title="json_node_set_boolean ()"><code class="function">json_node_set_boolean()</code></a>
503 </p>
504 <div class="variablelist"><table border="0">
505 <col align="left" valign="top">
506 <tbody>
507 <tr>
508 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
509 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
510 </td>
511 </tr>
512 <tr>
513 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
514 <td>a boolean value</td>
515 </tr>
516 </tbody>
517 </table></div>
518 <p class="since">Since 0.8</p>
519 </div>
520 <hr>
521 <div class="refsect2">
522 <a name="json-array-get-boolean-element"></a><h3>json_array_get_boolean_element ()</h3>
523 <pre class="programlisting"><span class="returnvalue">gboolean</span>            json_array_get_boolean_element      (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
524                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
525 <p>
526 Conveniently retrieves the boolean value of the element at <em class="parameter"><code>index_</code></em>
527 inside <em class="parameter"><code>array</code></em>
528 </p>
529 <p>
530 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-get-boolean" title="json_node_get_boolean ()"><code class="function">json_node_get_boolean()</code></a>
531 </p>
532 <div class="variablelist"><table border="0">
533 <col align="left" valign="top">
534 <tbody>
535 <tr>
536 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
537 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
538 </td>
539 </tr>
540 <tr>
541 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
542 <td>the index of the element to retrieve</td>
543 </tr>
544 <tr>
545 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
546 <td>the integer value</td>
547 </tr>
548 </tbody>
549 </table></div>
550 <p class="since">Since 0.8</p>
551 </div>
552 <hr>
553 <div class="refsect2">
554 <a name="json-array-add-double-element"></a><h3>json_array_add_double_element ()</h3>
555 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_double_element       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
556                                                          <em class="parameter"><code><span class="type">gdouble</span> value</code></em>);</pre>
557 <p>
558 Conveniently adds a floating point <em class="parameter"><code>value</code></em> into <em class="parameter"><code>array</code></em>
559 </p>
560 <p>
561 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-set-double" title="json_node_set_double ()"><code class="function">json_node_set_double()</code></a>
562 </p>
563 <div class="variablelist"><table border="0">
564 <col align="left" valign="top">
565 <tbody>
566 <tr>
567 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
568 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
569 </td>
570 </tr>
571 <tr>
572 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
573 <td>a floating point value</td>
574 </tr>
575 </tbody>
576 </table></div>
577 <p class="since">Since 0.8</p>
578 </div>
579 <hr>
580 <div class="refsect2">
581 <a name="json-array-get-double-element"></a><h3>json_array_get_double_element ()</h3>
582 <pre class="programlisting"><span class="returnvalue">gdouble</span>             json_array_get_double_element       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
583                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
584 <p>
585 Conveniently retrieves the floating point value of the element at
586 <em class="parameter"><code>index_</code></em> inside <em class="parameter"><code>array</code></em>
587 </p>
588 <p>
589 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-get-double" title="json_node_get_double ()"><code class="function">json_node_get_double()</code></a>
590 </p>
591 <div class="variablelist"><table border="0">
592 <col align="left" valign="top">
593 <tbody>
594 <tr>
595 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
596 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
597 </td>
598 </tr>
599 <tr>
600 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
601 <td>the index of the element to retrieve</td>
602 </tr>
603 <tr>
604 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
605 <td>the floating point value</td>
606 </tr>
607 </tbody>
608 </table></div>
609 <p class="since">Since 0.8</p>
610 </div>
611 <hr>
612 <div class="refsect2">
613 <a name="json-array-add-int-element"></a><h3>json_array_add_int_element ()</h3>
614 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_int_element          (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
615                                                          <em class="parameter"><code><span class="type">gint64</span> value</code></em>);</pre>
616 <p>
617 Conveniently adds an integer <em class="parameter"><code>value</code></em> into <em class="parameter"><code>array</code></em>
618 </p>
619 <p>
620 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-set-int" title="json_node_set_int ()"><code class="function">json_node_set_int()</code></a>
621 </p>
622 <div class="variablelist"><table border="0">
623 <col align="left" valign="top">
624 <tbody>
625 <tr>
626 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
627 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
628 </td>
629 </tr>
630 <tr>
631 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
632 <td>an integer value</td>
633 </tr>
634 </tbody>
635 </table></div>
636 <p class="since">Since 0.8</p>
637 </div>
638 <hr>
639 <div class="refsect2">
640 <a name="json-array-get-int-element"></a><h3>json_array_get_int_element ()</h3>
641 <pre class="programlisting"><span class="returnvalue">gint64</span>              json_array_get_int_element          (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
642                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
643 <p>
644 Conveniently retrieves the integer value of the element at <em class="parameter"><code>index_</code></em>
645 inside <em class="parameter"><code>array</code></em>
646 </p>
647 <p>
648 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-get-int" title="json_node_get_int ()"><code class="function">json_node_get_int()</code></a>
649 </p>
650 <div class="variablelist"><table border="0">
651 <col align="left" valign="top">
652 <tbody>
653 <tr>
654 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
655 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
656 </td>
657 </tr>
658 <tr>
659 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
660 <td>the index of the element to retrieve</td>
661 </tr>
662 <tr>
663 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
664 <td>the integer value</td>
665 </tr>
666 </tbody>
667 </table></div>
668 <p class="since">Since 0.8</p>
669 </div>
670 <hr>
671 <div class="refsect2">
672 <a name="json-array-add-null-element"></a><h3>json_array_add_null_element ()</h3>
673 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_null_element         (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>);</pre>
674 <p>
675 Conveniently adds a null element into <em class="parameter"><code>array</code></em>
676 </p>
677 <p>
678 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#JSON-NODE-NULL:CAPS"><code class="literal">JSON_NODE_NULL</code></a>
679 </p>
680 <div class="variablelist"><table border="0">
681 <col align="left" valign="top">
682 <tbody><tr>
683 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
684 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
685 </td>
686 </tr></tbody>
687 </table></div>
688 <p class="since">Since 0.8</p>
689 </div>
690 <hr>
691 <div class="refsect2">
692 <a name="json-array-get-null-element"></a><h3>json_array_get_null_element ()</h3>
693 <pre class="programlisting"><span class="returnvalue">gboolean</span>            json_array_get_null_element         (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
694                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
695 <p>
696 Conveniently retrieves whether the element at <em class="parameter"><code>index_</code></em> is set to null
697 </p>
698 <p>
699 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#JSON-NODE-TYPE:CAPS" title="JSON_NODE_TYPE()"><code class="function">JSON_NODE_TYPE()</code></a>, <a class="link" href="json-glib-JSON-Node.html#JSON-NODE-NULL:CAPS"><code class="literal">JSON_NODE_NULL</code></a>
700 </p>
701 <div class="variablelist"><table border="0">
702 <col align="left" valign="top">
703 <tbody>
704 <tr>
705 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
706 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
707 </td>
708 </tr>
709 <tr>
710 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
711 <td>the index of the element to retrieve</td>
712 </tr>
713 <tr>
714 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
715 <td>
716 <code class="literal">TRUE</code> if the element is null</td>
717 </tr>
718 </tbody>
719 </table></div>
720 <p class="since">Since 0.8</p>
721 </div>
722 <hr>
723 <div class="refsect2">
724 <a name="json-array-add-object-element"></a><h3>json_array_add_object_element ()</h3>
725 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_object_element       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
726                                                          <em class="parameter"><code><a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="type">JsonObject</span></a> *value</code></em>);</pre>
727 <p>
728 Conveniently adds an object into <em class="parameter"><code>array</code></em>. The <em class="parameter"><code>array</code></em> takes ownership
729 of the newly added <a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="type">JsonObject</span></a>
730 </p>
731 <p>
732 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-take-object" title="json_node_take_object ()"><code class="function">json_node_take_object()</code></a>
733 </p>
734 <div class="variablelist"><table border="0">
735 <col align="left" valign="top">
736 <tbody>
737 <tr>
738 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
739 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
740 </td>
741 </tr>
742 <tr>
743 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
744 <td>a <a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="type">JsonObject</span></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
745 </td>
746 </tr>
747 </tbody>
748 </table></div>
749 <p class="since">Since 0.8</p>
750 </div>
751 <hr>
752 <div class="refsect2">
753 <a name="json-array-get-object-element"></a><h3>json_array_get_object_element ()</h3>
754 <pre class="programlisting"><a class="link" href="json-glib-JSON-Object.html#JsonObject" title="JsonObject"><span class="returnvalue">JsonObject</span></a> *        json_array_get_object_element       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
755                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
756 <p>
757 Conveniently retrieves the object from the element at <em class="parameter"><code>index_</code></em>
758 inside <em class="parameter"><code>array</code></em>
759 </p>
760 <p>
761 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-get-object" title="json_node_get_object ()"><code class="function">json_node_get_object()</code></a>
762 </p>
763 <div class="variablelist"><table border="0">
764 <col align="left" valign="top">
765 <tbody>
766 <tr>
767 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
768 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
769 </td>
770 </tr>
771 <tr>
772 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
773 <td>the index of the element to retrieve</td>
774 </tr>
775 <tr>
776 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
777 <td>the object. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
778 </td>
779 </tr>
780 </tbody>
781 </table></div>
782 <p class="since">Since 0.8</p>
783 </div>
784 <hr>
785 <div class="refsect2">
786 <a name="json-array-add-string-element"></a><h3>json_array_add_string_element ()</h3>
787 <pre class="programlisting"><span class="returnvalue">void</span>                json_array_add_string_element       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
788                                                          <em class="parameter"><code>const <span class="type">gchar</span> *value</code></em>);</pre>
789 <p>
790 Conveniently adds a string <em class="parameter"><code>value</code></em> into <em class="parameter"><code>array</code></em>
791 </p>
792 <p>
793 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-add-element" title="json_array_add_element ()"><code class="function">json_array_add_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-set-string" title="json_node_set_string ()"><code class="function">json_node_set_string()</code></a>
794 </p>
795 <div class="variablelist"><table border="0">
796 <col align="left" valign="top">
797 <tbody>
798 <tr>
799 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
800 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
801 </td>
802 </tr>
803 <tr>
804 <td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
805 <td>a string value</td>
806 </tr>
807 </tbody>
808 </table></div>
809 <p class="since">Since 0.8</p>
810 </div>
811 <hr>
812 <div class="refsect2">
813 <a name="json-array-get-string-element"></a><h3>json_array_get_string_element ()</h3>
814 <pre class="programlisting">const <span class="returnvalue">gchar</span> *       json_array_get_string_element       (<em class="parameter"><code><a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> *array</code></em>,
815                                                          <em class="parameter"><code><span class="type">guint</span> index_</code></em>);</pre>
816 <p>
817 Conveniently retrieves the string value of the element at <em class="parameter"><code>index_</code></em>
818 inside <em class="parameter"><code>array</code></em>
819 </p>
820 <p>
821 See also: <a class="link" href="json-glib-JSON-Array.html#json-array-get-element" title="json_array_get_element ()"><code class="function">json_array_get_element()</code></a>, <a class="link" href="json-glib-JSON-Node.html#json-node-get-string" title="json_node_get_string ()"><code class="function">json_node_get_string()</code></a>
822 </p>
823 <div class="variablelist"><table border="0">
824 <col align="left" valign="top">
825 <tbody>
826 <tr>
827 <td><p><span class="term"><em class="parameter"><code>array</code></em> :</span></p></td>
828 <td>a <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a>
829 </td>
830 </tr>
831 <tr>
832 <td><p><span class="term"><em class="parameter"><code>index_</code></em> :</span></p></td>
833 <td>the index of the element to retrieve</td>
834 </tr>
835 <tr>
836 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
837 <td>the string value; the returned string is owned by
838 the <a class="link" href="json-glib-JSON-Array.html#JsonArray" title="JsonArray"><span class="type">JsonArray</span></a> and should not be modified or freed</td>
839 </tr>
840 </tbody>
841 </table></div>
842 <p class="since">Since 0.8</p>
843 </div>
844 </div>
845 </div>
846 <div class="footer">
847 <hr>
848           Generated by GTK-Doc V1.18.1</div>
849 </body>
850 </html>