1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="json-glib-JSON-Array">
<refmeta>
<refentrytitle role="top_of_page" id="json-glib-JSON-Array.top_of_page">JSON Array</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>JSON-GLIB Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>JSON Array</refname>
<refpurpose>a JSON array representation</refpurpose>
</refnamediv>
<refsynopsisdiv id="json-glib-JSON-Array.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="JsonArray">JsonArray</link>;
<link linkend="JsonArray">JsonArray</link> * <link linkend="json-array-new">json_array_new</link> (void);
<link linkend="JsonArray">JsonArray</link> * <link linkend="json-array-sized-new">json_array_sized_new</link> (<link linkend="guint">guint</link> n_elements);
<link linkend="JsonArray">JsonArray</link> * <link linkend="json-array-ref">json_array_ref</link> (<link linkend="JsonArray">JsonArray</link> *array);
<link linkend="void">void</link> <link linkend="json-array-unref">json_array_unref</link> (<link linkend="JsonArray">JsonArray</link> *array);
<link linkend="void">void</link> <link linkend="json-array-add-element">json_array_add_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonNode">JsonNode</link> *node);
<link linkend="JsonNode">JsonNode</link> * <link linkend="json-array-get-element">json_array_get_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="JsonNode">JsonNode</link> * <link linkend="json-array-dup-element">json_array_dup_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="GList">GList</link> * <link linkend="json-array-get-elements">json_array_get_elements</link> (<link linkend="JsonArray">JsonArray</link> *array);
<link linkend="guint">guint</link> <link linkend="json-array-get-length">json_array_get_length</link> (<link linkend="JsonArray">JsonArray</link> *array);
<link linkend="void">void</link> <link linkend="json-array-remove-element">json_array_remove_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> (<link linkend="JsonArrayForeach">*JsonArrayForeach</link>) (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_,
<link linkend="JsonNode">JsonNode</link> *element_node,
<link linkend="gpointer">gpointer</link> user_data);
<link linkend="void">void</link> <link linkend="json-array-foreach-element">json_array_foreach_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonArrayForeach">JsonArrayForeach</link> func,
<link linkend="gpointer">gpointer</link> data);
<link linkend="void">void</link> <link linkend="json-array-add-array-element">json_array_add_array_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonArray">JsonArray</link> *value);
<link linkend="JsonArray">JsonArray</link> * <link linkend="json-array-get-array-element">json_array_get_array_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> <link linkend="json-array-add-boolean-element">json_array_add_boolean_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gboolean">gboolean</link> value);
<link linkend="gboolean">gboolean</link> <link linkend="json-array-get-boolean-element">json_array_get_boolean_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> <link linkend="json-array-add-double-element">json_array_add_double_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gdouble">gdouble</link> value);
<link linkend="gdouble">gdouble</link> <link linkend="json-array-get-double-element">json_array_get_double_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> <link linkend="json-array-add-int-element">json_array_add_int_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gint64">gint64</link> value);
<link linkend="gint64">gint64</link> <link linkend="json-array-get-int-element">json_array_get_int_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> <link linkend="json-array-add-null-element">json_array_add_null_element</link> (<link linkend="JsonArray">JsonArray</link> *array);
<link linkend="gboolean">gboolean</link> <link linkend="json-array-get-null-element">json_array_get_null_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> <link linkend="json-array-add-object-element">json_array_add_object_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonObject">JsonObject</link> *value);
<link linkend="JsonObject">JsonObject</link> * <link linkend="json-array-get-object-element">json_array_get_object_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
<link linkend="void">void</link> <link linkend="json-array-add-string-element">json_array_add_string_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
const <link linkend="gchar">gchar</link> *value);
const <link linkend="gchar">gchar</link> * <link linkend="json-array-get-string-element">json_array_get_string_element</link> (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);
</synopsis>
</refsynopsisdiv>
<refsect1 id="json-glib-JSON-Array.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="JsonArray"><type>JsonArray</type></link> is the representation of the array type inside JSON. It contains
<link linkend="JsonNode"><type>JsonNode</type></link><!-- -->s, which may contain fundamental types, other arrays or
objects.
</para>
<para>
Since arrays can be expensive, they are reference counted. You can control
the lifetime of a <link linkend="JsonArray"><type>JsonArray</type></link> using <link linkend="json-array-ref"><function>json_array_ref()</function></link> and <link linkend="json-array-unref"><function>json_array_unref()</function></link>.
</para>
<para>
To append an element, use <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>.
To extract an element at a given index, use <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>.
To retrieve the entire array in list form, use <link linkend="json-array-get-elements"><function>json_array_get_elements()</function></link>.
To retrieve the length of the array, use <link linkend="json-array-get-length"><function>json_array_get_length()</function></link>.</para>
<para>
</para>
</refsect1>
<refsect1 id="json-glib-JSON-Array.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="JsonArray" role="struct">
<title>JsonArray</title>
<indexterm zone="JsonArray"><primary sortas="Array">JsonArray</primary></indexterm><programlisting>typedef struct _JsonArray JsonArray;</programlisting>
<para>
A JSON array type. The contents of the <link linkend="JsonArray"><type>JsonArray</type></link> structure are private
and should only be accessed by the provided API</para>
<para>
</para></refsect2>
<refsect2 id="json-array-new" role="function">
<title>json_array_new ()</title>
<indexterm zone="json-array-new"><primary sortas="array_new">json_array_new</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> * json_array_new (void);</programlisting>
<para>
Creates a new <link linkend="JsonArray"><type>JsonArray</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-sized-new" role="function">
<title>json_array_sized_new ()</title>
<indexterm zone="json-array-sized-new"><primary sortas="array_sized_new">json_array_sized_new</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> * json_array_sized_new (<link linkend="guint">guint</link> n_elements);</programlisting>
<para>
Creates a new <link linkend="JsonArray"><type>JsonArray</type></link> with <parameter>n_elements</parameter> slots already allocated.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>n_elements</parameter> :</term>
<listitem><simpara> number of slots to pre-allocate
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-ref" role="function">
<title>json_array_ref ()</title>
<indexterm zone="json-array-ref"><primary sortas="array_ref">json_array_ref</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> * json_array_ref (<link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Increase by one the reference count of a <link linkend="JsonArray"><type>JsonArray</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the passed <link linkend="JsonArray"><type>JsonArray</type></link>, with the reference count
increased by one.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-unref" role="function">
<title>json_array_unref ()</title>
<indexterm zone="json-array-unref"><primary sortas="array_unref">json_array_unref</primary></indexterm><programlisting><link linkend="void">void</link> json_array_unref (<link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Decreases by one the reference count of a <link linkend="JsonArray"><type>JsonArray</type></link>. If the
reference count reaches zero, the array is destroyed and all
its allocated resources are freed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-add-element" role="function">
<title>json_array_add_element ()</title>
<indexterm zone="json-array-add-element"><primary sortas="array_add_element">json_array_add_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonNode">JsonNode</link> *node);</programlisting>
<para>
Appends <parameter>node</parameter> inside <parameter>array</parameter>. The array will take ownership of the
<link linkend="JsonNode"><type>JsonNode</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>node</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-get-element" role="function">
<title>json_array_get_element ()</title>
<indexterm zone="json-array-get-element"><primary sortas="array_get_element">json_array_get_element</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * json_array_get_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Retrieves the <link linkend="JsonNode"><type>JsonNode</type></link> containing the value of the element at <parameter>index_</parameter>
inside a <link linkend="JsonArray"><type>JsonArray</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a pointer to the <link linkend="JsonNode"><type>JsonNode</type></link> at the requested index
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-dup-element" role="function" condition="since:0.6">
<title>json_array_dup_element ()</title>
<indexterm zone="json-array-dup-element" role="0.6"><primary sortas="array_dup_element">json_array_dup_element</primary></indexterm><programlisting><link linkend="JsonNode">JsonNode</link> * json_array_dup_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Retrieves a copy of the <link linkend="JsonNode"><type>JsonNode</type></link> containing the value of the
element at <parameter>index_</parameter> inside a <link linkend="JsonArray"><type>JsonArray</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>transfer full. <acronym>transfer</acronym> full. </simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.6</para></refsect2>
<refsect2 id="json-array-get-elements" role="function">
<title>json_array_get_elements ()</title>
<indexterm zone="json-array-get-elements"><primary sortas="array_get_elements">json_array_get_elements</primary></indexterm><programlisting><link linkend="GList">GList</link> * json_array_get_elements (<link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Gets the elements of a <link linkend="JsonArray"><type>JsonArray</type></link> as a list of <link linkend="JsonNode"><type>JsonNode</type></link><!-- -->s.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>element-type JsonNode) (transfer container. <acronym>element-type</acronym> JsonNode. <acronym>transfer</acronym> container. </simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-get-length" role="function">
<title>json_array_get_length ()</title>
<indexterm zone="json-array-get-length"><primary sortas="array_get_length">json_array_get_length</primary></indexterm><programlisting><link linkend="guint">guint</link> json_array_get_length (<link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Retrieves the length of a <link linkend="JsonArray"><type>JsonArray</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the length of the array
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="json-array-remove-element" role="function">
<title>json_array_remove_element ()</title>
<indexterm zone="json-array-remove-element"><primary sortas="array_remove_element">json_array_remove_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_remove_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Removes the <link linkend="JsonNode"><type>JsonNode</type></link> inside <parameter>array</parameter> at <parameter>index_</parameter> freeing its allocated
resources.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the position of the element to be removed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="JsonArrayForeach" role="function" condition="since:0.8">
<title>JsonArrayForeach ()</title>
<indexterm zone="JsonArrayForeach" role="0.8"><primary sortas="ArrayForeach">JsonArrayForeach</primary></indexterm><programlisting><link linkend="void">void</link> (*JsonArrayForeach) (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_,
<link linkend="JsonNode">JsonNode</link> *element_node,
<link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
The function to be passed to <link linkend="json-array-foreach-element"><function>json_array_foreach_element()</function></link>. You
should not add or remove elements to and from <parameter>array</parameter> within
this function. It is safe to change the value of <parameter>element_node</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> the iterated <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>element_node</parameter> :</term>
<listitem><simpara> a <link linkend="JsonNode"><type>JsonNode</type></link> containing the value at <parameter>index_</parameter>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara> data passed to the function
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-foreach-element" role="function" condition="since:0.8">
<title>json_array_foreach_element ()</title>
<indexterm zone="json-array-foreach-element" role="0.8"><primary sortas="array_foreach_element">json_array_foreach_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_foreach_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonArrayForeach">JsonArrayForeach</link> func,
<link linkend="gpointer">gpointer</link> data);</programlisting>
<para>
Iterates over all elements of <parameter>array</parameter> and calls <parameter>func</parameter> on
each one of them.
</para>
<para>
It is safe to change the value of a <link linkend="JsonNode"><type>JsonNode</type></link> of the <parameter>array</parameter>
from within the iterator <parameter>func</parameter>, but it is not safe to add or
remove elements from the <parameter>array</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>func</parameter> :</term>
<listitem><simpara> the function to be called on each element
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>data</parameter> :</term>
<listitem><simpara> data to be passed to the function. <acronym>allow-none</acronym>. </simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-array-element" role="function" condition="since:0.8">
<title>json_array_add_array_element ()</title>
<indexterm zone="json-array-add-array-element" role="0.8"><primary sortas="array_add_array_element">json_array_add_array_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_array_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonArray">JsonArray</link> *value);</programlisting>
<para>
Conveniently adds an array into <parameter>array</parameter>. The <parameter>array</parameter> takes ownership
of the newly added <link linkend="JsonArray"><type>JsonArray</type></link>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="json-node-take-array"><function>json_node_take_array()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-array-element" role="function" condition="since:0.8">
<title>json_array_get_array_element ()</title>
<indexterm zone="json-array-get-array-element" role="0.8"><primary sortas="array_get_array_element">json_array_get_array_element</primary></indexterm><programlisting><link linkend="JsonArray">JsonArray</link> * json_array_get_array_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves the array from the element at <parameter>index_</parameter>
inside <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="json-node-get-array"><function>json_node_get_array()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the array. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-boolean-element" role="function" condition="since:0.8">
<title>json_array_add_boolean_element ()</title>
<indexterm zone="json-array-add-boolean-element" role="0.8"><primary sortas="array_add_boolean_element">json_array_add_boolean_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_boolean_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gboolean">gboolean</link> value);</programlisting>
<para>
Conveniently adds a boolean <parameter>value</parameter> into <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="json-node-set-boolean"><function>json_node_set_boolean()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a boolean value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-boolean-element" role="function" condition="since:0.8">
<title>json_array_get_boolean_element ()</title>
<indexterm zone="json-array-get-boolean-element" role="0.8"><primary sortas="array_get_boolean_element">json_array_get_boolean_element</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_array_get_boolean_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves the boolean value of the element at <parameter>index_</parameter>
inside <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="json-node-get-boolean"><function>json_node_get_boolean()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the integer value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-double-element" role="function" condition="since:0.8">
<title>json_array_add_double_element ()</title>
<indexterm zone="json-array-add-double-element" role="0.8"><primary sortas="array_add_double_element">json_array_add_double_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_double_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gdouble">gdouble</link> value);</programlisting>
<para>
Conveniently adds a floating point <parameter>value</parameter> into <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="json-node-set-double"><function>json_node_set_double()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a floating point value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-double-element" role="function" condition="since:0.8">
<title>json_array_get_double_element ()</title>
<indexterm zone="json-array-get-double-element" role="0.8"><primary sortas="array_get_double_element">json_array_get_double_element</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> json_array_get_double_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves the floating point value of the element at
<parameter>index_</parameter> inside <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="json-node-get-double"><function>json_node_get_double()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the floating point value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-int-element" role="function" condition="since:0.8">
<title>json_array_add_int_element ()</title>
<indexterm zone="json-array-add-int-element" role="0.8"><primary sortas="array_add_int_element">json_array_add_int_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_int_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="gint64">gint64</link> value);</programlisting>
<para>
Conveniently adds an integer <parameter>value</parameter> into <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="json-node-set-int"><function>json_node_set_int()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> an integer value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-int-element" role="function" condition="since:0.8">
<title>json_array_get_int_element ()</title>
<indexterm zone="json-array-get-int-element" role="0.8"><primary sortas="array_get_int_element">json_array_get_int_element</primary></indexterm><programlisting><link linkend="gint64">gint64</link> json_array_get_int_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves the integer value of the element at <parameter>index_</parameter>
inside <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="json-node-get-int"><function>json_node_get_int()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the integer value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-null-element" role="function" condition="since:0.8">
<title>json_array_add_null_element ()</title>
<indexterm zone="json-array-add-null-element" role="0.8"><primary sortas="array_add_null_element">json_array_add_null_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_null_element (<link linkend="JsonArray">JsonArray</link> *array);</programlisting>
<para>
Conveniently adds a null element into <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="JSON-NODE-NULL--CAPS"><literal>JSON_NODE_NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-null-element" role="function" condition="since:0.8">
<title>json_array_get_null_element ()</title>
<indexterm zone="json-array-get-null-element" role="0.8"><primary sortas="array_get_null_element">json_array_get_null_element</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> json_array_get_null_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves whether the element at <parameter>index_</parameter> is set to null
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="JSON-NODE-TYPE--CAPS"><function>JSON_NODE_TYPE()</function></link>, <link linkend="JSON-NODE-NULL--CAPS"><literal>JSON_NODE_NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the element is null
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-object-element" role="function" condition="since:0.8">
<title>json_array_add_object_element ()</title>
<indexterm zone="json-array-add-object-element" role="0.8"><primary sortas="array_add_object_element">json_array_add_object_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_object_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="JsonObject">JsonObject</link> *value);</programlisting>
<para>
Conveniently adds an object into <parameter>array</parameter>. The <parameter>array</parameter> takes ownership
of the newly added <link linkend="JsonObject"><type>JsonObject</type></link>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="json-node-take-object"><function>json_node_take_object()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a <link linkend="JsonObject"><type>JsonObject</type></link>
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-object-element" role="function" condition="since:0.8">
<title>json_array_get_object_element ()</title>
<indexterm zone="json-array-get-object-element" role="0.8"><primary sortas="array_get_object_element">json_array_get_object_element</primary></indexterm><programlisting><link linkend="JsonObject">JsonObject</link> * json_array_get_object_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves the object from the element at <parameter>index_</parameter>
inside <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="json-node-get-object"><function>json_node_get_object()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the object. <acronym>transfer</acronym> none. </simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-add-string-element" role="function" condition="since:0.8">
<title>json_array_add_string_element ()</title>
<indexterm zone="json-array-add-string-element" role="0.8"><primary sortas="array_add_string_element">json_array_add_string_element</primary></indexterm><programlisting><link linkend="void">void</link> json_array_add_string_element (<link linkend="JsonArray">JsonArray</link> *array,
const <link linkend="gchar">gchar</link> *value);</programlisting>
<para>
Conveniently adds a string <parameter>value</parameter> into <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-add-element"><function>json_array_add_element()</function></link>, <link linkend="json-node-set-string"><function>json_node_set_string()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>value</parameter> :</term>
<listitem><simpara> a string value
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
<refsect2 id="json-array-get-string-element" role="function" condition="since:0.8">
<title>json_array_get_string_element ()</title>
<indexterm zone="json-array-get-string-element" role="0.8"><primary sortas="array_get_string_element">json_array_get_string_element</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> * json_array_get_string_element (<link linkend="JsonArray">JsonArray</link> *array,
<link linkend="guint">guint</link> index_);</programlisting>
<para>
Conveniently retrieves the string value of the element at <parameter>index_</parameter>
inside <parameter>array</parameter>
</para>
<para>
See also: <link linkend="json-array-get-element"><function>json_array_get_element()</function></link>, <link linkend="json-node-get-string"><function>json_node_get_string()</function></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>array</parameter> :</term>
<listitem><simpara> a <link linkend="JsonArray"><type>JsonArray</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>index_</parameter> :</term>
<listitem><simpara> the index of the element to retrieve
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string value; the returned string is owned by
the <link linkend="JsonArray"><type>JsonArray</type></link> and should not be modified or freed
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.8</para></refsect2>
</refsect1>
</refentry>
|
