~ubuntu-branches/ubuntu/trusty/glib2.0/trusty-proposed

« back to all changes in this revision

Viewing changes to docs/reference/glib/xml/gvarianttype.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-23 19:25:52 UTC
  • mfrom: (3.4.9 experimental)
  • Revision ID: james.westby@ubuntu.com-20100323192552-istna8c33bw6harh
Tags: 2.23.6-1ubuntu1
* Resync on Debian
* debian/patches/01_gettext-desktopfiles.patch:
  - updated to use gettext for X-GNOME-Fullname too
* debian/patches/71_gio_launch_handler.patch:
  - new gio default launch handle feature required for wncksync
* debian/control.in, 
  debian/patches/80-gtester-subunit.patch:
  - gtester-report subunit support
* debian/libglib2.0-0.symbols:
  - updated the symbols list for the gio launcher handler

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
5
 
<!ENTITY version SYSTEM "version.xml">
6
 
]>
7
 
<refentry id="glib-GVariantType">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="glib-GVariantType.top_of_page">GVariantType</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>GLIB Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>GVariantType</refname>
16
 
<refpurpose>introduction to the GVariant type system</refpurpose>
17
 
</refnamediv>
18
 
 
19
 
<refsynopsisdiv id="glib-GVariantType.synopsis" role="synopsis">
20
 
<title role="synopsis.title">Synopsis</title>
21
 
 
22
 
<synopsis>
23
 
 
24
 
#include &lt;glib.h&gt;
25
 
 
26
 
                    <link linkend="GVariantType">GVariantType</link>;
27
 
#define             <link linkend="G-VARIANT-TYPE-BOOLEAN--CAPS">G_VARIANT_TYPE_BOOLEAN</link>
28
 
#define             <link linkend="G-VARIANT-TYPE-BYTE--CAPS">G_VARIANT_TYPE_BYTE</link>
29
 
#define             <link linkend="G-VARIANT-TYPE-INT16--CAPS">G_VARIANT_TYPE_INT16</link>
30
 
#define             <link linkend="G-VARIANT-TYPE-UINT16--CAPS">G_VARIANT_TYPE_UINT16</link>
31
 
#define             <link linkend="G-VARIANT-TYPE-INT32--CAPS">G_VARIANT_TYPE_INT32</link>
32
 
#define             <link linkend="G-VARIANT-TYPE-UINT32--CAPS">G_VARIANT_TYPE_UINT32</link>
33
 
#define             <link linkend="G-VARIANT-TYPE-INT64--CAPS">G_VARIANT_TYPE_INT64</link>
34
 
#define             <link linkend="G-VARIANT-TYPE-UINT64--CAPS">G_VARIANT_TYPE_UINT64</link>
35
 
#define             <link linkend="G-VARIANT-TYPE-HANDLE--CAPS">G_VARIANT_TYPE_HANDLE</link>
36
 
#define             <link linkend="G-VARIANT-TYPE-DOUBLE--CAPS">G_VARIANT_TYPE_DOUBLE</link>
37
 
#define             <link linkend="G-VARIANT-TYPE-STRING--CAPS">G_VARIANT_TYPE_STRING</link>
38
 
#define             <link linkend="G-VARIANT-TYPE-OBJECT-PATH--CAPS">G_VARIANT_TYPE_OBJECT_PATH</link>
39
 
#define             <link linkend="G-VARIANT-TYPE-SIGNATURE--CAPS">G_VARIANT_TYPE_SIGNATURE</link>
40
 
#define             <link linkend="G-VARIANT-TYPE-VARIANT--CAPS">G_VARIANT_TYPE_VARIANT</link>
41
 
#define             <link linkend="G-VARIANT-TYPE-ANY--CAPS">G_VARIANT_TYPE_ANY</link>
42
 
#define             <link linkend="G-VARIANT-TYPE-BASIC--CAPS">G_VARIANT_TYPE_BASIC</link>
43
 
#define             <link linkend="G-VARIANT-TYPE-MAYBE--CAPS">G_VARIANT_TYPE_MAYBE</link>
44
 
#define             <link linkend="G-VARIANT-TYPE-ARRAY--CAPS">G_VARIANT_TYPE_ARRAY</link>
45
 
#define             <link linkend="G-VARIANT-TYPE-TUPLE--CAPS">G_VARIANT_TYPE_TUPLE</link>
46
 
#define             <link linkend="G-VARIANT-TYPE-UNIT--CAPS">G_VARIANT_TYPE_UNIT</link>
47
 
#define             <link linkend="G-VARIANT-TYPE-DICT-ENTRY--CAPS">G_VARIANT_TYPE_DICT_ENTRY</link>
48
 
#define             <link linkend="G-VARIANT-TYPE-DICTIONARY--CAPS">G_VARIANT_TYPE_DICTIONARY</link>
49
 
 
50
 
#define             <link linkend="G-VARIANT-TYPE--CAPS">G_VARIANT_TYPE</link>                      (type_string)
51
 
<link linkend="void">void</link>                <link linkend="g-variant-type-free">g_variant_type_free</link>                 (<link linkend="GVariantType">GVariantType</link> *type);
52
 
<link linkend="GVariantType">GVariantType</link> *      <link linkend="g-variant-type-copy">g_variant_type_copy</link>                 (const <link linkend="GVariantType">GVariantType</link> *type);
53
 
<link linkend="GVariantType">GVariantType</link> *      <link linkend="g-variant-type-new">g_variant_type_new</link>                  (const <link linkend="gchar">gchar</link> *type_string);
54
 
 
55
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-string-is-valid">g_variant_type_string_is_valid</link>      (const <link linkend="gchar">gchar</link> *type_string);
56
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-string-scan">g_variant_type_string_scan</link>          (const <link linkend="gchar">gchar</link> *string,
57
 
                                                         const <link linkend="gchar">gchar</link> *limit,
58
 
                                                         const <link linkend="gchar">gchar</link> **endptr);
59
 
<link linkend="gsize">gsize</link>               <link linkend="g-variant-type-get-string-length">g_variant_type_get_string_length</link>    (const <link linkend="GVariantType">GVariantType</link> *type);
60
 
const <link linkend="gchar">gchar</link> *       <link linkend="g-variant-type-peek-string">g_variant_type_peek_string</link>          (const <link linkend="GVariantType">GVariantType</link> *type);
61
 
<link linkend="gchar">gchar</link> *             <link linkend="g-variant-type-dup-string">g_variant_type_dup_string</link>           (const <link linkend="GVariantType">GVariantType</link> *type);
62
 
 
63
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-definite">g_variant_type_is_definite</link>          (const <link linkend="GVariantType">GVariantType</link> *type);
64
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-container">g_variant_type_is_container</link>         (const <link linkend="GVariantType">GVariantType</link> *type);
65
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-basic">g_variant_type_is_basic</link>             (const <link linkend="GVariantType">GVariantType</link> *type);
66
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-maybe">g_variant_type_is_maybe</link>             (const <link linkend="GVariantType">GVariantType</link> *type);
67
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-array">g_variant_type_is_array</link>             (const <link linkend="GVariantType">GVariantType</link> *type);
68
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-tuple">g_variant_type_is_tuple</link>             (const <link linkend="GVariantType">GVariantType</link> *type);
69
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-dict-entry">g_variant_type_is_dict_entry</link>        (const <link linkend="GVariantType">GVariantType</link> *type);
70
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-variant">g_variant_type_is_variant</link>           (const <link linkend="GVariantType">GVariantType</link> *type);
71
 
 
72
 
<link linkend="guint">guint</link>               <link linkend="g-variant-type-hash">g_variant_type_hash</link>                 (<link linkend="gconstpointer">gconstpointer</link> type);
73
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-equal">g_variant_type_equal</link>                (<link linkend="gconstpointer">gconstpointer</link> type1,
74
 
                                                         <link linkend="gconstpointer">gconstpointer</link> type2);
75
 
<link linkend="gboolean">gboolean</link>            <link linkend="g-variant-type-is-subtype-of">g_variant_type_is_subtype_of</link>        (const <link linkend="GVariantType">GVariantType</link> *type,
76
 
                                                         const <link linkend="GVariantType">GVariantType</link> *supertype);
77
 
 
78
 
<link linkend="GVariantType">GVariantType</link> *      <link linkend="g-variant-type-new-maybe">g_variant_type_new_maybe</link>            (const <link linkend="GVariantType">GVariantType</link> *element);
79
 
<link linkend="GVariantType">GVariantType</link> *      <link linkend="g-variant-type-new-array">g_variant_type_new_array</link>            (const <link linkend="GVariantType">GVariantType</link> *element);
80
 
<link linkend="GVariantType">GVariantType</link> *      <link linkend="g-variant-type-new-tuple">g_variant_type_new_tuple</link>            (const <link linkend="GVariantType">GVariantType</link> * const *items,
81
 
                                                         <link linkend="gint">gint</link> length);
82
 
<link linkend="GVariantType">GVariantType</link> *      <link linkend="g-variant-type-new-dict-entry">g_variant_type_new_dict_entry</link>       (const <link linkend="GVariantType">GVariantType</link> *key,
83
 
                                                         const <link linkend="GVariantType">GVariantType</link> *value);
84
 
 
85
 
const <link linkend="GVariantType">GVariantType</link> * <link linkend="g-variant-type-element">g_variant_type_element</link>             (const <link linkend="GVariantType">GVariantType</link> *type);
86
 
<link linkend="gsize">gsize</link>               <link linkend="g-variant-type-n-items">g_variant_type_n_items</link>              (const <link linkend="GVariantType">GVariantType</link> *type);
87
 
const <link linkend="GVariantType">GVariantType</link> * <link linkend="g-variant-type-first">g_variant_type_first</link>               (const <link linkend="GVariantType">GVariantType</link> *type);
88
 
const <link linkend="GVariantType">GVariantType</link> * <link linkend="g-variant-type-next">g_variant_type_next</link>                (const <link linkend="GVariantType">GVariantType</link> *type);
89
 
const <link linkend="GVariantType">GVariantType</link> * <link linkend="g-variant-type-key">g_variant_type_key</link>                 (const <link linkend="GVariantType">GVariantType</link> *type);
90
 
const <link linkend="GVariantType">GVariantType</link> * <link linkend="g-variant-type-value">g_variant_type_value</link>               (const <link linkend="GVariantType">GVariantType</link> *type);
91
 
</synopsis>
92
 
</refsynopsisdiv>
93
 
 
94
 
 
95
 
 
96
 
 
97
 
 
98
 
 
99
 
 
100
 
 
101
 
 
102
 
<refsect1 id="glib-GVariantType.description" role="desc">
103
 
<title role="desc.title">Description</title>
104
 
<para>
105
 
This section introduces the GVariant type system.  It is based, in
106
 
large part, on the DBus type system, with two major changes and some minor
107
 
lifting of restrictions.  The <ulink
108
 
url='http://dbus.freedesktop.org/doc/dbus-specification.html'>DBus
109
 
specification</ulink>, therefore, provides a significant amount of
110
 
information that is useful when working with GVariant.
111
 
</para>
112
 
<para>
113
 
The first major change with respect to the DBus type system is the
114
 
introduction of maybe (or "nullable") types.  Any type in GVariant can be
115
 
converted to a maybe type, in which case, "nothing" (or "null") becomes a
116
 
valid value.  Maybe types have been added by introducing the
117
 
character "<literal>m</literal>" to type strings.
118
 
</para>
119
 
<para>
120
 
The second major change is that the GVariant type system supports the
121
 
concept of "indefinite types" -- types that are less specific than
122
 
the normal types found in DBus.  For example, it is possible to speak
123
 
of "an array of any type" in GVariant, where the DBus type system
124
 
would require you to speak of "an array of integers" or "an array of
125
 
strings".  Indefinite types have been added by introducing the
126
 
characters "<literal>*</literal>", "<literal>?</literal>" and
127
 
"<literal>r</literal>" to type strings.
128
 
</para>
129
 
<para>
130
 
Finally, all arbitrary restrictions relating to the complexity of
131
 
types are lifted along with the restriction that dictionary entries
132
 
may only appear nested inside of arrays.
133
 
</para>
134
 
<para>
135
 
Just as in DBus, GVariant types are described with strings ("type
136
 
strings").  Subject to the differences mentioned above, these strings
137
 
are of the same form as those found in DBus.  Note, however: DBus
138
 
always works in terms of messages and therefore individual type
139
 
strings appear nowhere in its interface.  Instead, "signatures"
140
 
are a concatenation of the strings of the type of each argument in a
141
 
message.  GVariant deals with single values directly so GVariant type
142
 
strings always describe the type of exactly one value.  This means
143
 
that a DBus signature string is generally not a valid GVariant type
144
 
string -- except in the case that it is the signature of a message
145
 
containing exactly one argument.
146
 
</para>
147
 
<para>
148
 
An indefinite type is similar in spirit to what may be called an
149
 
abstract type in other type systems.  No value can exist that has an
150
 
indefinite type as its type, but values can exist that have types
151
 
that are subtypes of indefinite types.  That is to say,
152
 
<link linkend="g-variant-get-type"><function>g_variant_get_type()</function></link> will never return an indefinite type, but
153
 
calling <link linkend="g-variant-is-a"><function>g_variant_is_a()</function></link> with an indefinite type may return <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>.
154
 
For example, you can not have a value that represents "an array of no
155
 
particular type", but you can have an "array of integers" which
156
 
certainly matches the type of "an array of no particular type", since
157
 
"array of integers" is a subtype of "array of no particular type".
158
 
</para>
159
 
<para>
160
 
This is similar to how instances of abstract classes may not
161
 
directly exist in other type systems, but instances of their
162
 
non-abstract subtypes may.  For example, in GTK, no object that has
163
 
the type of <link linkend="GtkBin"><type>GtkBin</type></link> can exist (since <link linkend="GtkBin"><type>GtkBin</type></link> is an abstract class),
164
 
but a <link linkend="GtkWindow"><type>GtkWindow</type></link> can certainly be instantiated, and you would say
165
 
that the <link linkend="GtkWindow"><type>GtkWindow</type></link> is a <link linkend="GtkBin"><type>GtkBin</type></link> (since <link linkend="GtkWindow"><type>GtkWindow</type></link> is a subclass of
166
 
<link linkend="GtkBin"><type>GtkBin</type></link>).
167
 
</para>
168
 
<para>
169
 
A detailed description of GVariant type strings is given here:
170
 
</para>
171
 
<para>
172
 
<refsect2 id='gvariant-typestrings'>
173
 
 <title>GVariant Type Strings</title>
174
 
 <para>
175
 
  A GVariant type string can be any of the following:
176
 
 </para>
177
 
 <itemizedlist>
178
 
  <listitem>
179
 
   <para>
180
 
    any basic type string (listed below)
181
 
   </para>
182
 
  </listitem>
183
 
  <listitem>
184
 
   <para>
185
 
    "<literal>v</literal>", "<literal>r</literal>" or
186
 
    "<literal>*</literal>"
187
 
   </para>
188
 
  </listitem>
189
 
  <listitem>
190
 
   <para>
191
 
    one of the characters '<literal>a</literal>' or
192
 
    '<literal>m</literal>', followed by another type string
193
 
   </para>
194
 
  </listitem>
195
 
  <listitem>
196
 
   <para>
197
 
    the character '<literal>(</literal>', followed by a concatenation
198
 
    of zero or more other type strings, followed by the character
199
 
    '<literal>)</literal>'
200
 
   </para>
201
 
  </listitem>
202
 
  <listitem>
203
 
   <para>
204
 
    the character '<literal>{</literal>', followed by a basic type
205
 
    string (see below), followed by another type string, followed by
206
 
    the character '<literal>}</literal>'
207
 
   </para>
208
 
  </listitem>
209
 
 </itemizedlist>
210
 
 <para>
211
 
  A basic type string describes a basic type (as per
212
 
  <link linkend="g-variant-type-is-basic"><function>g_variant_type_is_basic()</function></link>) and is always a single
213
 
  character in length.  The valid basic type strings are
214
 
  "<literal>b</literal>", "<literal>y</literal>",
215
 
  "<literal>n</literal>", "<literal>q</literal>",
216
 
  "<literal>i</literal>", "<literal>u</literal>",
217
 
  "<literal>x</literal>", "<literal>t</literal>",
218
 
  "<literal>h</literal>", "<literal>d</literal>",
219
 
  "<literal>s</literal>", "<literal>o</literal>",
220
 
  "<literal>g</literal>" and "<literal>?</literal>".
221
 
 </para>
222
 
 <para>
223
 
  The above definition is recursive to arbitrary depth.
224
 
  "<literal>aaaaai</literal>" and "<literal>(ui(nq((y)))s)</literal>"
225
 
  are both valid type strings, as is
226
 
  "<literal>a(aa(ui)(qna{ya(yd)}))</literal>".
227
 
 </para>
228
 
 <para>
229
 
  The meaning of each of the characters is as follows:
230
 
 </para>
231
 
 <informaltable>
232
 
  <tgroup cols='2'>
233
 
   <tbody>
234
 
    <row>
235
 
     <entry>
236
 
      <para>
237
 
       <emphasis role='strong'>Character</emphasis>
238
 
      </para>
239
 
     </entry>
240
 
     <entry>
241
 
      <para>
242
 
       <emphasis role='strong'>Meaning</emphasis>
243
 
      </para>
244
 
     </entry>
245
 
    </row>
246
 
    <row>
247
 
     <entry>
248
 
      <para>
249
 
       <literal>b</literal>
250
 
      </para>
251
 
     </entry>
252
 
     <entry>
253
 
      <para>
254
 
       the type string of <link linkend="G-VARIANT-TYPE-BOOLEAN--CAPS"><literal>G_VARIANT_TYPE_BOOLEAN</literal></link>; a boolean value.
255
 
      </para>
256
 
     </entry>
257
 
    </row>
258
 
    <row>
259
 
     <entry>
260
 
      <para>
261
 
       <literal>y</literal>
262
 
      </para>
263
 
     </entry>
264
 
     <entry>
265
 
      <para>
266
 
       the type string of <link linkend="G-VARIANT-TYPE-BYTE--CAPS"><literal>G_VARIANT_TYPE_BYTE</literal></link>; a byte.
267
 
      </para>
268
 
     </entry>
269
 
    </row>
270
 
    <row>
271
 
     <entry>
272
 
      <para>
273
 
       <literal>n</literal>
274
 
      </para>
275
 
     </entry>
276
 
     <entry>
277
 
      <para>
278
 
       the type string of <link linkend="G-VARIANT-TYPE-INT16--CAPS"><literal>G_VARIANT_TYPE_INT16</literal></link>; a signed 16 bit
279
 
       integer.
280
 
      </para>
281
 
     </entry>
282
 
    </row>
283
 
    <row>
284
 
     <entry>
285
 
      <para>
286
 
       <literal>q</literal>
287
 
      </para>
288
 
     </entry>
289
 
     <entry>
290
 
      <para>
291
 
       the type string of <link linkend="G-VARIANT-TYPE-UINT16--CAPS"><literal>G_VARIANT_TYPE_UINT16</literal></link>; an unsigned 16 bit
292
 
       integer.
293
 
      </para>
294
 
     </entry>
295
 
    </row>
296
 
    <row>
297
 
     <entry>
298
 
      <para>
299
 
       <literal>i</literal>
300
 
      </para>
301
 
     </entry>
302
 
     <entry>
303
 
      <para>
304
 
       the type string of <link linkend="G-VARIANT-TYPE-INT32--CAPS"><literal>G_VARIANT_TYPE_INT32</literal></link>; a signed 32 bit
305
 
       integer.
306
 
      </para>
307
 
     </entry>
308
 
    </row>
309
 
    <row>
310
 
     <entry>
311
 
      <para>
312
 
       <literal>u</literal>
313
 
      </para>
314
 
     </entry>
315
 
     <entry>
316
 
      <para>
317
 
       the type string of <link linkend="G-VARIANT-TYPE-UINT32--CAPS"><literal>G_VARIANT_TYPE_UINT32</literal></link>; an unsigned 32 bit
318
 
       integer.
319
 
      </para>
320
 
     </entry>
321
 
    </row>
322
 
    <row>
323
 
     <entry>
324
 
      <para>
325
 
       <literal>x</literal>
326
 
      </para>
327
 
     </entry>
328
 
     <entry>
329
 
      <para>
330
 
       the type string of <link linkend="G-VARIANT-TYPE-INT64--CAPS"><literal>G_VARIANT_TYPE_INT64</literal></link>; a signed 64 bit
331
 
       integer.
332
 
      </para>
333
 
     </entry>
334
 
    </row>
335
 
    <row>
336
 
     <entry>
337
 
      <para>
338
 
       <literal>t</literal>
339
 
      </para>
340
 
     </entry>
341
 
     <entry>
342
 
      <para>
343
 
       the type string of <link linkend="G-VARIANT-TYPE-UINT64--CAPS"><literal>G_VARIANT_TYPE_UINT64</literal></link>; an unsigned 64 bit
344
 
       integer.
345
 
      </para>
346
 
     </entry>
347
 
    </row>
348
 
    <row>
349
 
     <entry>
350
 
      <para>
351
 
       <literal>h</literal>
352
 
      </para>
353
 
     </entry>
354
 
     <entry>
355
 
      <para>
356
 
       the type string of <link linkend="G-VARIANT-TYPE-HANDLE--CAPS"><literal>G_VARIANT_TYPE_HANDLE</literal></link>; a signed 32 bit
357
 
       value that, by convention, is used as an index into an array
358
 
       of file descriptors that are sent alongside a DBus message.
359
 
      </para>
360
 
     </entry>
361
 
    </row>
362
 
    <row>
363
 
     <entry>
364
 
      <para>
365
 
       <literal>d</literal>
366
 
      </para>
367
 
     </entry>
368
 
     <entry>
369
 
      <para>
370
 
       the type string of <link linkend="G-VARIANT-TYPE-DOUBLE--CAPS"><literal>G_VARIANT_TYPE_DOUBLE</literal></link>; a double precision
371
 
       floating point value.
372
 
      </para>
373
 
     </entry>
374
 
    </row>
375
 
    <row>
376
 
     <entry>
377
 
      <para>
378
 
       <literal>s</literal>
379
 
      </para>
380
 
     </entry>
381
 
     <entry>
382
 
      <para>
383
 
       the type string of <link linkend="G-VARIANT-TYPE-STRING--CAPS"><literal>G_VARIANT_TYPE_STRING</literal></link>; a string.
384
 
      </para>
385
 
     </entry>
386
 
    </row>
387
 
    <row>
388
 
     <entry>
389
 
      <para>
390
 
       <literal>o</literal>
391
 
      </para>
392
 
     </entry>
393
 
     <entry>
394
 
      <para>
395
 
       the type string of <link linkend="G-VARIANT-TYPE-OBJECT-PATH--CAPS"><literal>G_VARIANT_TYPE_OBJECT_PATH</literal></link>; a string in
396
 
       the form of a DBus object path.
397
 
      </para>
398
 
     </entry>
399
 
    </row>
400
 
    <row>
401
 
     <entry>
402
 
      <para>
403
 
       <literal>g</literal>
404
 
      </para>
405
 
     </entry>
406
 
     <entry>
407
 
      <para>
408
 
       the type string of <link linkend="G-VARIANT-TYPE-STRING--CAPS"><literal>G_VARIANT_TYPE_STRING</literal></link>; a string in the
409
 
       form of a DBus type signature.
410
 
      </para>
411
 
     </entry>
412
 
    </row>
413
 
    <row>
414
 
     <entry>
415
 
      <para>
416
 
       <literal>?</literal>
417
 
      </para>
418
 
     </entry>
419
 
     <entry>
420
 
      <para>
421
 
       the type string of <link linkend="G-VARIANT-TYPE-BASIC--CAPS"><literal>G_VARIANT_TYPE_BASIC</literal></link>; an indefinite type
422
 
       that is a supertype of any of the basic types.
423
 
      </para>
424
 
     </entry>
425
 
    </row>
426
 
    <row>
427
 
     <entry>
428
 
      <para>
429
 
       <literal>v</literal>
430
 
      </para>
431
 
     </entry>
432
 
     <entry>
433
 
      <para>
434
 
       the type string of <link linkend="G-VARIANT-TYPE-VARIANT--CAPS"><literal>G_VARIANT_TYPE_VARIANT</literal></link>; a container type
435
 
       that contain any other type of value.
436
 
      </para>
437
 
     </entry>
438
 
    </row>
439
 
    <row>
440
 
     <entry>
441
 
      <para>
442
 
       <literal>a</literal>
443
 
      </para>
444
 
     </entry>
445
 
     <entry>
446
 
      <para>
447
 
       used as a prefix on another type string to mean an array of
448
 
       that type; the type string "<literal>ai</literal>", for
449
 
       example, is the type of an array of 32 bit signed integers.
450
 
      </para>
451
 
     </entry>
452
 
    </row>
453
 
    <row>
454
 
     <entry>
455
 
      <para>
456
 
       <literal>m</literal>
457
 
      </para>
458
 
     </entry>
459
 
     <entry>
460
 
      <para>
461
 
       used as a prefix on another type string to mean a "maybe", or
462
 
       "nullable", version of that type; the type string
463
 
       "<literal>ms</literal>", for example, is the type of a value
464
 
       that maybe contains a string, or maybe contains nothing.
465
 
      </para>
466
 
     </entry>
467
 
    </row>
468
 
    <row>
469
 
     <entry>
470
 
      <para>
471
 
       <literal>()</literal>
472
 
      </para>
473
 
     </entry>
474
 
     <entry>
475
 
      <para>
476
 
       used to enclose zero or more other concatenated type strings
477
 
       to create a tuple type; the type string
478
 
       "<literal>(is)</literal>", for example, is the type of a pair
479
 
       of an integer and a string.
480
 
      </para>
481
 
     </entry>
482
 
    </row>
483
 
    <row>
484
 
     <entry>
485
 
      <para>
486
 
       <literal>r</literal>
487
 
      </para>
488
 
     </entry>
489
 
     <entry>
490
 
      <para>
491
 
       the type string of <link linkend="G-VARIANT-TYPE-TUPLE--CAPS"><literal>G_VARIANT_TYPE_TUPLE</literal></link>; an indefinite type
492
 
       that is a supertype of any tuple type, regardless of the
493
 
       number of items.
494
 
      </para>
495
 
     </entry>
496
 
    </row>
497
 
    <row>
498
 
     <entry>
499
 
      <para>
500
 
       <literal>{}</literal>
501
 
      </para>
502
 
     </entry>
503
 
     <entry>
504
 
      <para>
505
 
       used to enclose a basic type string concatenated with another
506
 
       type string to create a dictionary entry type, which usually
507
 
       appears inside of an array to form a dictionary; the type
508
 
       string "<literal>a{sd}</literal>", for example, is the type of
509
 
       a dictionary that maps strings to double precision floating
510
 
       point values.
511
 
      </para>
512
 
      <para>
513
 
       The first type (the basic type) is the key type and the second
514
 
       type is the value type.  The reason that the first type is
515
 
       restricted to being a basic type is so that it can easily be
516
 
       hashed.
517
 
      </para>
518
 
     </entry>
519
 
    </row>
520
 
    <row>
521
 
     <entry>
522
 
      <para>
523
 
       <literal>*</literal>
524
 
      </para>
525
 
     </entry>
526
 
     <entry>
527
 
      <para>
528
 
       the type string of <link linkend="G-VARIANT-TYPE-ANY--CAPS"><literal>G_VARIANT_TYPE_ANY</literal></link>; the indefinite type
529
 
       that is a supertype of all types.  Note that, as with all type
530
 
       strings, this character represents exactly one type.  It
531
 
       cannot be used inside of tuples to mean "any number of items".
532
 
      </para>
533
 
     </entry>
534
 
    </row>
535
 
   </tbody>
536
 
  </tgroup>
537
 
 </informaltable>
538
 
 <para>
539
 
  Any type string of a container that contains an indefinite type is,
540
 
  itself, an indefinite type.  For example, the type string
541
 
  "<literal>a*</literal>" (corresponding to <link linkend="G-VARIANT-TYPE-ARRAY--CAPS"><literal>G_VARIANT_TYPE_ARRAY</literal></link>) is
542
 
  an indefinite type that is a supertype of every array type.
543
 
  "<literal>(*s)</literal>" is a supertype of all tuples that
544
 
  contain exactly two items where the second item is a string.
545
 
 </para>
546
 
 <para>
547
 
  "<literal>a{?*}</literal>" is an indefinite type that is a
548
 
  supertype of all arrays containing dictionary entries where the key
549
 
  is any basic type and the value is any type at all.  This is, by
550
 
  definition, a dictionary, so this type string corresponds to
551
 
  <link linkend="G-VARIANT-TYPE-DICTIONARY--CAPS"><literal>G_VARIANT_TYPE_DICTIONARY</literal></link>.  Note that, due to the restriction that
552
 
  the key of a dictionary entry must be a basic type,
553
 
  "<literal>{**}</literal>" is not a valid type string.
554
 
 </para>
555
 
</refsect2></para>
556
 
<para>
557
 
</para>
558
 
</refsect1>
559
 
 
560
 
<refsect1 id="glib-GVariantType.details" role="details">
561
 
<title role="details.title">Details</title>
562
 
<refsect2 id="GVariantType" role="struct">
563
 
<title>GVariantType</title>
564
 
<indexterm zone="GVariantType"><primary sortas="VariantType">GVariantType</primary></indexterm><programlisting>typedef struct _GVariantType GVariantType;</programlisting>
565
 
<para>
566
 
A type in the GVariant type system.
567
 
</para>
568
 
<para>
569
 
Two types may not be compared by value; use <link linkend="g-variant-type-equal"><function>g_variant_type_equal()</function></link> or
570
 
<link linkend="g-variant-type-is-subtype"><function>g_variant_type_is_subtype()</function></link>.  May be copied using
571
 
<link linkend="g-variant-type-copy"><function>g_variant_type_copy()</function></link> and freed using <link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link>.</para>
572
 
<para>
573
 
</para></refsect2>
574
 
<refsect2 id="G-VARIANT-TYPE-BOOLEAN--CAPS" role="macro">
575
 
<title>G_VARIANT_TYPE_BOOLEAN</title>
576
 
<indexterm zone="G-VARIANT-TYPE-BOOLEAN--CAPS"><primary sortas="VARIANT_TYPE_BOOLEAN">G_VARIANT_TYPE_BOOLEAN</primary></indexterm><programlisting>#define G_VARIANT_TYPE_BOOLEAN              ((const GVariantType *) "b")
577
 
</programlisting>
578
 
<para>
579
 
The type of a value that can be either <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> or <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>.</para>
580
 
<para>
581
 
</para></refsect2>
582
 
<refsect2 id="G-VARIANT-TYPE-BYTE--CAPS" role="macro">
583
 
<title>G_VARIANT_TYPE_BYTE</title>
584
 
<indexterm zone="G-VARIANT-TYPE-BYTE--CAPS"><primary sortas="VARIANT_TYPE_BYTE">G_VARIANT_TYPE_BYTE</primary></indexterm><programlisting>#define G_VARIANT_TYPE_BYTE                 ((const GVariantType *) "y")
585
 
</programlisting>
586
 
<para>
587
 
The type of an integer value that can range from 0 to 255.</para>
588
 
<para>
589
 
</para></refsect2>
590
 
<refsect2 id="G-VARIANT-TYPE-INT16--CAPS" role="macro">
591
 
<title>G_VARIANT_TYPE_INT16</title>
592
 
<indexterm zone="G-VARIANT-TYPE-INT16--CAPS"><primary sortas="VARIANT_TYPE_INT16">G_VARIANT_TYPE_INT16</primary></indexterm><programlisting>#define G_VARIANT_TYPE_INT16                ((const GVariantType *) "n")
593
 
</programlisting>
594
 
<para>
595
 
The type of an integer value that can range from -32768 to 32767.</para>
596
 
<para>
597
 
</para></refsect2>
598
 
<refsect2 id="G-VARIANT-TYPE-UINT16--CAPS" role="macro">
599
 
<title>G_VARIANT_TYPE_UINT16</title>
600
 
<indexterm zone="G-VARIANT-TYPE-UINT16--CAPS"><primary sortas="VARIANT_TYPE_UINT16">G_VARIANT_TYPE_UINT16</primary></indexterm><programlisting>#define G_VARIANT_TYPE_UINT16               ((const GVariantType *) "q")
601
 
</programlisting>
602
 
<para>
603
 
The type of an integer value that can range from 0 to 65535.
604
 
There were about this many people living in Toronto in the 1870s.</para>
605
 
<para>
606
 
</para></refsect2>
607
 
<refsect2 id="G-VARIANT-TYPE-INT32--CAPS" role="macro">
608
 
<title>G_VARIANT_TYPE_INT32</title>
609
 
<indexterm zone="G-VARIANT-TYPE-INT32--CAPS"><primary sortas="VARIANT_TYPE_INT32">G_VARIANT_TYPE_INT32</primary></indexterm><programlisting>#define G_VARIANT_TYPE_INT32                ((const GVariantType *) "i")
610
 
</programlisting>
611
 
<para>
612
 
The type of an integer value that can range from -2147483648 to
613
 
2147483647.</para>
614
 
<para>
615
 
</para></refsect2>
616
 
<refsect2 id="G-VARIANT-TYPE-UINT32--CAPS" role="macro">
617
 
<title>G_VARIANT_TYPE_UINT32</title>
618
 
<indexterm zone="G-VARIANT-TYPE-UINT32--CAPS"><primary sortas="VARIANT_TYPE_UINT32">G_VARIANT_TYPE_UINT32</primary></indexterm><programlisting>#define G_VARIANT_TYPE_UINT32               ((const GVariantType *) "u")
619
 
</programlisting>
620
 
<para>
621
 
The type of an integer value that can range from 0 to 4294967295.
622
 
That's one number for everyone who was around in the late 1970s.</para>
623
 
<para>
624
 
</para></refsect2>
625
 
<refsect2 id="G-VARIANT-TYPE-INT64--CAPS" role="macro">
626
 
<title>G_VARIANT_TYPE_INT64</title>
627
 
<indexterm zone="G-VARIANT-TYPE-INT64--CAPS"><primary sortas="VARIANT_TYPE_INT64">G_VARIANT_TYPE_INT64</primary></indexterm><programlisting>#define G_VARIANT_TYPE_INT64                ((const GVariantType *) "x")
628
 
</programlisting>
629
 
<para>
630
 
The type of an integer value that can range from
631
 
-9223372036854775808 to 9223372036854775807.</para>
632
 
<para>
633
 
</para></refsect2>
634
 
<refsect2 id="G-VARIANT-TYPE-UINT64--CAPS" role="macro">
635
 
<title>G_VARIANT_TYPE_UINT64</title>
636
 
<indexterm zone="G-VARIANT-TYPE-UINT64--CAPS"><primary sortas="VARIANT_TYPE_UINT64">G_VARIANT_TYPE_UINT64</primary></indexterm><programlisting>#define G_VARIANT_TYPE_UINT64               ((const GVariantType *) "t")
637
 
</programlisting>
638
 
<para>
639
 
The type of an integer value that can range from 0 to
640
 
18446744073709551616.  That's a really big number, but a Rubik's
641
 
cube can have a bit more than twice as many possible positions.</para>
642
 
<para>
643
 
</para></refsect2>
644
 
<refsect2 id="G-VARIANT-TYPE-HANDLE--CAPS" role="macro">
645
 
<title>G_VARIANT_TYPE_HANDLE</title>
646
 
<indexterm zone="G-VARIANT-TYPE-HANDLE--CAPS"><primary sortas="VARIANT_TYPE_HANDLE">G_VARIANT_TYPE_HANDLE</primary></indexterm><programlisting>#define G_VARIANT_TYPE_HANDLE               ((const GVariantType *) "h")
647
 
</programlisting>
648
 
<para>
649
 
The type of a 32bit signed integer value, that by convention, is used
650
 
as an index into an array of file descriptors that are sent alongside
651
 
a DBus message.
652
 
</para>
653
 
<para>
654
 
If you are not interacting with DBus, then there is no reason to make
655
 
use of this type.</para>
656
 
<para>
657
 
</para></refsect2>
658
 
<refsect2 id="G-VARIANT-TYPE-DOUBLE--CAPS" role="macro">
659
 
<title>G_VARIANT_TYPE_DOUBLE</title>
660
 
<indexterm zone="G-VARIANT-TYPE-DOUBLE--CAPS"><primary sortas="VARIANT_TYPE_DOUBLE">G_VARIANT_TYPE_DOUBLE</primary></indexterm><programlisting>#define G_VARIANT_TYPE_DOUBLE               ((const GVariantType *) "d")
661
 
</programlisting>
662
 
<para>
663
 
The type of a double precision IEEE754 floating point number.
664
 
These guys go up to about 1.80e308 (plus and minus) but miss out on
665
 
some numbers in between.  In any case, that's far greater than the
666
 
estimated number of fundamental particles in the observable
667
 
universe.</para>
668
 
<para>
669
 
</para></refsect2>
670
 
<refsect2 id="G-VARIANT-TYPE-STRING--CAPS" role="macro">
671
 
<title>G_VARIANT_TYPE_STRING</title>
672
 
<indexterm zone="G-VARIANT-TYPE-STRING--CAPS"><primary sortas="VARIANT_TYPE_STRING">G_VARIANT_TYPE_STRING</primary></indexterm><programlisting>#define G_VARIANT_TYPE_STRING               ((const GVariantType *) "s")
673
 
</programlisting>
674
 
<para>
675
 
The type of a string.  "" is a string.  <link linkend="NULL--CAPS"><literal>NULL</literal></link> is not a string.</para>
676
 
<para>
677
 
</para></refsect2>
678
 
<refsect2 id="G-VARIANT-TYPE-OBJECT-PATH--CAPS" role="macro">
679
 
<title>G_VARIANT_TYPE_OBJECT_PATH</title>
680
 
<indexterm zone="G-VARIANT-TYPE-OBJECT-PATH--CAPS"><primary sortas="VARIANT_TYPE_OBJECT_PATH">G_VARIANT_TYPE_OBJECT_PATH</primary></indexterm><programlisting>#define G_VARIANT_TYPE_OBJECT_PATH          ((const GVariantType *) "o")
681
 
</programlisting>
682
 
<para>
683
 
The type of a DBus object reference.  These are strings of a
684
 
specific format used to identify objects at a given destination on
685
 
the bus.
686
 
</para>
687
 
<para>
688
 
If you are not interacting with DBus, then there is no reason to make
689
 
use of this type.  If you are, then the DBus specification contains a
690
 
precise description of valid object paths.</para>
691
 
<para>
692
 
</para></refsect2>
693
 
<refsect2 id="G-VARIANT-TYPE-SIGNATURE--CAPS" role="macro">
694
 
<title>G_VARIANT_TYPE_SIGNATURE</title>
695
 
<indexterm zone="G-VARIANT-TYPE-SIGNATURE--CAPS"><primary sortas="VARIANT_TYPE_SIGNATURE">G_VARIANT_TYPE_SIGNATURE</primary></indexterm><programlisting>#define G_VARIANT_TYPE_SIGNATURE            ((const GVariantType *) "g")
696
 
</programlisting>
697
 
<para>
698
 
The type of a DBus type signature.  These are strings of a specific
699
 
format used as type signatures for DBus methods and messages.
700
 
</para>
701
 
<para>
702
 
If you are not interacting with DBus, then there is no reason to make
703
 
use of this type.  If you are, then the DBus specification contains a
704
 
precise description of valid signature strings.</para>
705
 
<para>
706
 
</para></refsect2>
707
 
<refsect2 id="G-VARIANT-TYPE-VARIANT--CAPS" role="macro">
708
 
<title>G_VARIANT_TYPE_VARIANT</title>
709
 
<indexterm zone="G-VARIANT-TYPE-VARIANT--CAPS"><primary sortas="VARIANT_TYPE_VARIANT">G_VARIANT_TYPE_VARIANT</primary></indexterm><programlisting>#define G_VARIANT_TYPE_VARIANT              ((const GVariantType *) "v")
710
 
</programlisting>
711
 
<para>
712
 
The type of a box that contains any other value (including another
713
 
variant).</para>
714
 
<para>
715
 
</para></refsect2>
716
 
<refsect2 id="G-VARIANT-TYPE-ANY--CAPS" role="macro">
717
 
<title>G_VARIANT_TYPE_ANY</title>
718
 
<indexterm zone="G-VARIANT-TYPE-ANY--CAPS"><primary sortas="VARIANT_TYPE_ANY">G_VARIANT_TYPE_ANY</primary></indexterm><programlisting>#define G_VARIANT_TYPE_ANY                  ((const GVariantType *) "*")
719
 
</programlisting>
720
 
<para>
721
 
An indefinite type that is a supertype of every type (including
722
 
itself).</para>
723
 
<para>
724
 
</para></refsect2>
725
 
<refsect2 id="G-VARIANT-TYPE-BASIC--CAPS" role="macro">
726
 
<title>G_VARIANT_TYPE_BASIC</title>
727
 
<indexterm zone="G-VARIANT-TYPE-BASIC--CAPS"><primary sortas="VARIANT_TYPE_BASIC">G_VARIANT_TYPE_BASIC</primary></indexterm><programlisting>#define G_VARIANT_TYPE_BASIC                ((const GVariantType *) "?")
728
 
</programlisting>
729
 
<para>
730
 
An indefinite type that is a supertype of every basic (ie:
731
 
non-container) type.</para>
732
 
<para>
733
 
</para></refsect2>
734
 
<refsect2 id="G-VARIANT-TYPE-MAYBE--CAPS" role="macro">
735
 
<title>G_VARIANT_TYPE_MAYBE</title>
736
 
<indexterm zone="G-VARIANT-TYPE-MAYBE--CAPS"><primary sortas="VARIANT_TYPE_MAYBE">G_VARIANT_TYPE_MAYBE</primary></indexterm><programlisting>#define G_VARIANT_TYPE_MAYBE                ((const GVariantType *) "m*")
737
 
</programlisting>
738
 
<para>
739
 
An indefinite type that is a supertype of every maybe type.</para>
740
 
<para>
741
 
</para></refsect2>
742
 
<refsect2 id="G-VARIANT-TYPE-ARRAY--CAPS" role="macro">
743
 
<title>G_VARIANT_TYPE_ARRAY</title>
744
 
<indexterm zone="G-VARIANT-TYPE-ARRAY--CAPS"><primary sortas="VARIANT_TYPE_ARRAY">G_VARIANT_TYPE_ARRAY</primary></indexterm><programlisting>#define G_VARIANT_TYPE_ARRAY                ((const GVariantType *) "a*")
745
 
</programlisting>
746
 
<para>
747
 
An indefinite type that is a supertype of every array type.</para>
748
 
<para>
749
 
</para></refsect2>
750
 
<refsect2 id="G-VARIANT-TYPE-TUPLE--CAPS" role="macro">
751
 
<title>G_VARIANT_TYPE_TUPLE</title>
752
 
<indexterm zone="G-VARIANT-TYPE-TUPLE--CAPS"><primary sortas="VARIANT_TYPE_TUPLE">G_VARIANT_TYPE_TUPLE</primary></indexterm><programlisting>#define G_VARIANT_TYPE_TUPLE                ((const GVariantType *) "r")
753
 
</programlisting>
754
 
<para>
755
 
An indefinite type that is a supertype of every tuple type,
756
 
regardless of the number of items in the tuple.</para>
757
 
<para>
758
 
</para></refsect2>
759
 
<refsect2 id="G-VARIANT-TYPE-UNIT--CAPS" role="macro">
760
 
<title>G_VARIANT_TYPE_UNIT</title>
761
 
<indexterm zone="G-VARIANT-TYPE-UNIT--CAPS"><primary sortas="VARIANT_TYPE_UNIT">G_VARIANT_TYPE_UNIT</primary></indexterm><programlisting>#define G_VARIANT_TYPE_UNIT                 ((const GVariantType *) "()")
762
 
</programlisting>
763
 
<para>
764
 
The empty tuple type.  Has only one instance.  Known also as "triv"
765
 
or "void".</para>
766
 
<para>
767
 
</para></refsect2>
768
 
<refsect2 id="G-VARIANT-TYPE-DICT-ENTRY--CAPS" role="macro">
769
 
<title>G_VARIANT_TYPE_DICT_ENTRY</title>
770
 
<indexterm zone="G-VARIANT-TYPE-DICT-ENTRY--CAPS"><primary sortas="VARIANT_TYPE_DICT_ENTRY">G_VARIANT_TYPE_DICT_ENTRY</primary></indexterm><programlisting>#define G_VARIANT_TYPE_DICT_ENTRY           ((const GVariantType *) "{?*}")
771
 
</programlisting>
772
 
<para>
773
 
An indefinite type that is a supertype of every dictionary entry
774
 
type.</para>
775
 
<para>
776
 
</para></refsect2>
777
 
<refsect2 id="G-VARIANT-TYPE-DICTIONARY--CAPS" role="macro">
778
 
<title>G_VARIANT_TYPE_DICTIONARY</title>
779
 
<indexterm zone="G-VARIANT-TYPE-DICTIONARY--CAPS"><primary sortas="VARIANT_TYPE_DICTIONARY">G_VARIANT_TYPE_DICTIONARY</primary></indexterm><programlisting>#define G_VARIANT_TYPE_DICTIONARY           ((const GVariantType *) "a{?*}")
780
 
</programlisting>
781
 
<para>
782
 
An indefinite type that is a supertype of every dictionary type --
783
 
that is, any array type that has an element type equal to any
784
 
dictionary entry type.</para>
785
 
<para>
786
 
</para></refsect2>
787
 
<refsect2 id="G-VARIANT-TYPE--CAPS" role="macro">
788
 
<title>G_VARIANT_TYPE()</title>
789
 
<indexterm zone="G-VARIANT-TYPE--CAPS"><primary sortas="VARIANT_TYPE">G_VARIANT_TYPE</primary></indexterm><programlisting>#define             G_VARIANT_TYPE(type_string)</programlisting>
790
 
<para>
791
 
Converts a string to a const <link linkend="GVariantType"><type>GVariantType</type></link>.  Depending on the
792
 
current debugging level, this function may perform a runtime check
793
 
to ensure that <parameter>string</parameter> is a valid GVariant type string.
794
 
</para>
795
 
<para>
796
 
It is always a programmer error to use this macro with an invalid
797
 
type string.
798
 
</para>
799
 
<para>
800
 
Since 2.24</para>
801
 
<para>
802
 
</para><variablelist role="params">
803
 
<varlistentry><term><parameter>type_string</parameter>&#160;:</term>
804
 
<listitem><simpara> a well-formed <link linkend="GVariantType"><type>GVariantType</type></link> type string
805
 
</simpara></listitem></varlistentry>
806
 
</variablelist></refsect2>
807
 
<refsect2 id="g-variant-type-free" role="function">
808
 
<title>g_variant_type_free ()</title>
809
 
<indexterm zone="g-variant-type-free"><primary sortas="variant_type_free">g_variant_type_free</primary></indexterm><programlisting><link linkend="void">void</link>                g_variant_type_free                 (<link linkend="GVariantType">GVariantType</link> *type);</programlisting>
810
 
<para>
811
 
Frees a <link linkend="GVariantType"><type>GVariantType</type></link> that was allocated with
812
 
<link linkend="g-variant-type-copy"><function>g_variant_type_copy()</function></link>, <link linkend="g-variant-type-new"><function>g_variant_type_new()</function></link> or one of the container
813
 
type constructor functions.
814
 
</para>
815
 
<para>
816
 
In the case that <parameter>type</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>, this function does nothing.
817
 
</para>
818
 
<para>
819
 
Since 2.24</para>
820
 
<para>
821
 
</para><variablelist role="params">
822
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
823
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
824
 
</simpara></listitem></varlistentry>
825
 
</variablelist></refsect2>
826
 
<refsect2 id="g-variant-type-copy" role="function">
827
 
<title>g_variant_type_copy ()</title>
828
 
<indexterm zone="g-variant-type-copy"><primary sortas="variant_type_copy">g_variant_type_copy</primary></indexterm><programlisting><link linkend="GVariantType">GVariantType</link> *      g_variant_type_copy                 (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
829
 
<para>
830
 
Makes a copy of a <link linkend="GVariantType"><type>GVariantType</type></link>.  It is appropriate to call
831
 
<link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link> on the return value.  <parameter>type</parameter> may not be <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
832
 
</para>
833
 
<para>
834
 
Since 2.24</para>
835
 
<para>
836
 
</para><variablelist role="params">
837
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
838
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
839
 
</simpara></listitem></varlistentry>
840
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GVariantType"><type>GVariantType</type></link>
841
 
</simpara></listitem></varlistentry>
842
 
</variablelist></refsect2>
843
 
<refsect2 id="g-variant-type-new" role="function" condition="since:2.24">
844
 
<title>g_variant_type_new ()</title>
845
 
<indexterm zone="g-variant-type-new" role="2.24"><primary sortas="variant_type_new">g_variant_type_new</primary></indexterm><programlisting><link linkend="GVariantType">GVariantType</link> *      g_variant_type_new                  (const <link linkend="gchar">gchar</link> *type_string);</programlisting>
846
 
<para>
847
 
Creates a new <link linkend="GVariantType"><type>GVariantType</type></link> corresponding to the type string given
848
 
by <parameter>type_string</parameter>.  It is appropriate to call <link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link> on
849
 
the return value.
850
 
</para>
851
 
<para>
852
 
It is a programmer error to call this function with an invalid type
853
 
string.  Use <link linkend="g-variant-type-string-is-valid"><function>g_variant_type_string_is_valid()</function></link> if you are unsure.</para>
854
 
<para>
855
 
</para><variablelist role="params">
856
 
<varlistentry><term><parameter>type_string</parameter>&#160;:</term>
857
 
<listitem><simpara> a valid GVariant type string
858
 
</simpara></listitem></varlistentry>
859
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="GVariantType"><type>GVariantType</type></link>
860
 
</simpara></listitem></varlistentry>
861
 
</variablelist><para role="since">Since 2.24</para></refsect2>
862
 
<refsect2 id="g-variant-type-string-is-valid" role="function">
863
 
<title>g_variant_type_string_is_valid ()</title>
864
 
<indexterm zone="g-variant-type-string-is-valid"><primary sortas="variant_type_string_is_valid">g_variant_type_string_is_valid</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_string_is_valid      (const <link linkend="gchar">gchar</link> *type_string);</programlisting>
865
 
<para>
866
 
Checks if <parameter>type_string</parameter> is a valid GVariant type string.  This call is
867
 
equivalent to calling <link linkend="g-variant-type-string-scan"><function>g_variant_type_string_scan()</function></link> and confirming
868
 
that the following character is a nul terminator.
869
 
</para>
870
 
<para>
871
 
Since 2.24</para>
872
 
<para>
873
 
</para><variablelist role="params">
874
 
<varlistentry><term><parameter>type_string</parameter>&#160;:</term>
875
 
<listitem><simpara> a pointer to any string
876
 
</simpara></listitem></varlistentry>
877
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type_string</parameter> is exactly one valid type string
878
 
</simpara></listitem></varlistentry>
879
 
</variablelist></refsect2>
880
 
<refsect2 id="g-variant-type-string-scan" role="function" condition="since:2.24">
881
 
<title>g_variant_type_string_scan ()</title>
882
 
<indexterm zone="g-variant-type-string-scan" role="2.24"><primary sortas="variant_type_string_scan">g_variant_type_string_scan</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_string_scan          (const <link linkend="gchar">gchar</link> *string,
883
 
                                                         const <link linkend="gchar">gchar</link> *limit,
884
 
                                                         const <link linkend="gchar">gchar</link> **endptr);</programlisting>
885
 
<para>
886
 
Scan for a single complete and valid GVariant type string in <parameter>string</parameter>.
887
 
The memory pointed to by <parameter>limit</parameter> (or bytes beyond it) is never
888
 
accessed.
889
 
</para>
890
 
<para>
891
 
If a valid type string is found, <parameter>endptr</parameter> is updated to point to the
892
 
first character past the end of the string that was found and <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>
893
 
is returned.
894
 
</para>
895
 
<para>
896
 
If there is no valid type string starting at <parameter>string</parameter>, or if the type
897
 
string does not end before <parameter>limit</parameter> then <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> is returned.
898
 
</para>
899
 
<para>
900
 
For the simple case of checking if a string is a valid type string,
901
 
see <link linkend="g-variant-type-string-is-valid"><function>g_variant_type_string_is_valid()</function></link>.</para>
902
 
<para>
903
 
</para><variablelist role="params">
904
 
<varlistentry><term><parameter>string</parameter>&#160;:</term>
905
 
<listitem><simpara> a pointer to any string
906
 
</simpara></listitem></varlistentry>
907
 
<varlistentry><term><parameter>limit</parameter>&#160;:</term>
908
 
<listitem><simpara> the end of <parameter>string</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
909
 
</simpara></listitem></varlistentry>
910
 
<varlistentry><term><parameter>endptr</parameter>&#160;:</term>
911
 
<listitem><simpara> location to store the end pointer, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
912
 
</simpara></listitem></varlistentry>
913
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if a valid type string was found
914
 
</simpara></listitem></varlistentry>
915
 
</variablelist><para role="since">Since 2.24</para></refsect2>
916
 
<refsect2 id="g-variant-type-get-string-length" role="function">
917
 
<title>g_variant_type_get_string_length ()</title>
918
 
<indexterm zone="g-variant-type-get-string-length"><primary sortas="variant_type_get_string_length">g_variant_type_get_string_length</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               g_variant_type_get_string_length    (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
919
 
<para>
920
 
Returns the length of the type string corresponding to the given
921
 
<parameter>type</parameter>.  This function must be used to determine the valid extent of
922
 
the memory region returned by <link linkend="g-variant-type-peek-string"><function>g_variant_type_peek_string()</function></link>.
923
 
</para>
924
 
<para>
925
 
Since 2.24</para>
926
 
<para>
927
 
</para><variablelist role="params">
928
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
929
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
930
 
</simpara></listitem></varlistentry>
931
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the length of the corresponding type string
932
 
</simpara></listitem></varlistentry>
933
 
</variablelist></refsect2>
934
 
<refsect2 id="g-variant-type-peek-string" role="function">
935
 
<title>g_variant_type_peek_string ()</title>
936
 
<indexterm zone="g-variant-type-peek-string"><primary sortas="variant_type_peek_string">g_variant_type_peek_string</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       g_variant_type_peek_string          (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
937
 
<para>
938
 
Returns the type string corresponding to the given <parameter>type</parameter>.  The
939
 
result is not nul-terminated; in order to determine its length you
940
 
must call <link linkend="g-variant-type-get-string-length"><function>g_variant_type_get_string_length()</function></link>.
941
 
</para>
942
 
<para>
943
 
To get a nul-terminated string, see <link linkend="g-variant-type-dup-string"><function>g_variant_type_dup_string()</function></link>.
944
 
</para>
945
 
<para>
946
 
Since 2.24</para>
947
 
<para>
948
 
</para><variablelist role="params">
949
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
950
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
951
 
</simpara></listitem></varlistentry>
952
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the corresponding type string (not nul-terminated)
953
 
</simpara></listitem></varlistentry>
954
 
</variablelist></refsect2>
955
 
<refsect2 id="g-variant-type-dup-string" role="function">
956
 
<title>g_variant_type_dup_string ()</title>
957
 
<indexterm zone="g-variant-type-dup-string"><primary sortas="variant_type_dup_string">g_variant_type_dup_string</primary></indexterm><programlisting><link linkend="gchar">gchar</link> *             g_variant_type_dup_string           (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
958
 
<para>
959
 
Returns a newly-allocated copy of the type string corresponding to
960
 
<parameter>type</parameter>.  The returned string is nul-terminated.  It is appropriate to
961
 
call <link linkend="g-free"><function>g_free()</function></link> on the return value.
962
 
</para>
963
 
<para>
964
 
Since 2.24</para>
965
 
<para>
966
 
</para><variablelist role="params">
967
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
968
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
969
 
</simpara></listitem></varlistentry>
970
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the corresponding type string
971
 
</simpara></listitem></varlistentry>
972
 
</variablelist></refsect2>
973
 
<refsect2 id="g-variant-type-is-definite" role="function">
974
 
<title>g_variant_type_is_definite ()</title>
975
 
<indexterm zone="g-variant-type-is-definite"><primary sortas="variant_type_is_definite">g_variant_type_is_definite</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_definite          (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
976
 
<para>
977
 
Determines if the given <parameter>type</parameter> is definite (ie: not indefinite).
978
 
</para>
979
 
<para>
980
 
A type is definite if its type string does not contain any indefinite
981
 
type characters ('*', '?', or 'r').
982
 
</para>
983
 
<para>
984
 
A <link linkend="GVariant"><type>GVariant</type></link> instance may not have an indefinite type, so calling
985
 
this function on the result of <link linkend="g-variant-get-type"><function>g_variant_get_type()</function></link> will always
986
 
result in <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> being returned.  Calling this function on an
987
 
indefinite type like <link linkend="G-VARIANT-TYPE-ARRAY--CAPS"><literal>G_VARIANT_TYPE_ARRAY</literal></link>, however, will result in
988
 
<link linkend="FALSE--CAPS"><literal>FALSE</literal></link> being returned.
989
 
</para>
990
 
<para>
991
 
Since 2.24</para>
992
 
<para>
993
 
</para><variablelist role="params">
994
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
995
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
996
 
</simpara></listitem></varlistentry>
997
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is definite
998
 
</simpara></listitem></varlistentry>
999
 
</variablelist></refsect2>
1000
 
<refsect2 id="g-variant-type-is-container" role="function">
1001
 
<title>g_variant_type_is_container ()</title>
1002
 
<indexterm zone="g-variant-type-is-container"><primary sortas="variant_type_is_container">g_variant_type_is_container</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_container         (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1003
 
<para>
1004
 
Determines if the given <parameter>type</parameter> is a container type.
1005
 
</para>
1006
 
<para>
1007
 
Container types are any array, maybe, tuple, or dictionary
1008
 
entry types plus the variant type.
1009
 
</para>
1010
 
<para>
1011
 
This function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for any indefinite type for which every
1012
 
definite subtype is a container -- <link linkend="G-VARIANT-TYPE-ARRAY--CAPS"><literal>G_VARIANT_TYPE_ARRAY</literal></link>, for
1013
 
example.
1014
 
</para>
1015
 
<para>
1016
 
Since 2.24</para>
1017
 
<para>
1018
 
</para><variablelist role="params">
1019
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1020
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1021
 
</simpara></listitem></varlistentry>
1022
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a container type
1023
 
</simpara></listitem></varlistentry>
1024
 
</variablelist></refsect2>
1025
 
<refsect2 id="g-variant-type-is-basic" role="function">
1026
 
<title>g_variant_type_is_basic ()</title>
1027
 
<indexterm zone="g-variant-type-is-basic"><primary sortas="variant_type_is_basic">g_variant_type_is_basic</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_basic             (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1028
 
<para>
1029
 
Determines if the given <parameter>type</parameter> is a basic type.
1030
 
</para>
1031
 
<para>
1032
 
Basic types are booleans, bytes, integers, doubles, strings, object
1033
 
paths and signatures.
1034
 
</para>
1035
 
<para>
1036
 
Only a basic type may be used as the key of a dictionary entry.
1037
 
</para>
1038
 
<para>
1039
 
This function returns <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> for all indefinite types except
1040
 
<link linkend="G-VARIANT-TYPE-BASIC--CAPS"><literal>G_VARIANT_TYPE_BASIC</literal></link>.
1041
 
</para>
1042
 
<para>
1043
 
Since 2.24</para>
1044
 
<para>
1045
 
</para><variablelist role="params">
1046
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1047
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1048
 
</simpara></listitem></varlistentry>
1049
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a basic type
1050
 
</simpara></listitem></varlistentry>
1051
 
</variablelist></refsect2>
1052
 
<refsect2 id="g-variant-type-is-maybe" role="function">
1053
 
<title>g_variant_type_is_maybe ()</title>
1054
 
<indexterm zone="g-variant-type-is-maybe"><primary sortas="variant_type_is_maybe">g_variant_type_is_maybe</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_maybe             (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1055
 
<para>
1056
 
Determines if the given <parameter>type</parameter> is a maybe type.  This is true if the
1057
 
type string for <parameter>type</parameter> starts with an 'm'.
1058
 
</para>
1059
 
<para>
1060
 
This function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for any indefinite type for which every
1061
 
definite subtype is a maybe type -- <link linkend="G-VARIANT-TYPE-MAYBE--CAPS"><literal>G_VARIANT_TYPE_MAYBE</literal></link>, for
1062
 
example.
1063
 
</para>
1064
 
<para>
1065
 
Since 2.24</para>
1066
 
<para>
1067
 
</para><variablelist role="params">
1068
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1069
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1070
 
</simpara></listitem></varlistentry>
1071
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a maybe type
1072
 
</simpara></listitem></varlistentry>
1073
 
</variablelist></refsect2>
1074
 
<refsect2 id="g-variant-type-is-array" role="function">
1075
 
<title>g_variant_type_is_array ()</title>
1076
 
<indexterm zone="g-variant-type-is-array"><primary sortas="variant_type_is_array">g_variant_type_is_array</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_array             (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1077
 
<para>
1078
 
Determines if the given <parameter>type</parameter> is an array type.  This is true if the
1079
 
type string for <parameter>type</parameter> starts with an 'a'.
1080
 
</para>
1081
 
<para>
1082
 
This function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for any indefinite type for which every
1083
 
definite subtype is an array type -- <link linkend="G-VARIANT-TYPE-ARRAY--CAPS"><literal>G_VARIANT_TYPE_ARRAY</literal></link>, for
1084
 
example.
1085
 
</para>
1086
 
<para>
1087
 
Since 2.24</para>
1088
 
<para>
1089
 
</para><variablelist role="params">
1090
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1091
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1092
 
</simpara></listitem></varlistentry>
1093
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is an array type
1094
 
</simpara></listitem></varlistentry>
1095
 
</variablelist></refsect2>
1096
 
<refsect2 id="g-variant-type-is-tuple" role="function">
1097
 
<title>g_variant_type_is_tuple ()</title>
1098
 
<indexterm zone="g-variant-type-is-tuple"><primary sortas="variant_type_is_tuple">g_variant_type_is_tuple</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_tuple             (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1099
 
<para>
1100
 
Determines if the given <parameter>type</parameter> is a tuple type.  This is true if the
1101
 
type string for <parameter>type</parameter> starts with a '(' or if <parameter>type</parameter> is
1102
 
<link linkend="G-VARIANT-TYPE-TUPLE--CAPS"><literal>G_VARIANT_TYPE_TUPLE</literal></link>.
1103
 
</para>
1104
 
<para>
1105
 
This function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for any indefinite type for which every
1106
 
definite subtype is a tuple type -- <link linkend="G-VARIANT-TYPE-TUPLE--CAPS"><literal>G_VARIANT_TYPE_TUPLE</literal></link>, for
1107
 
example.
1108
 
</para>
1109
 
<para>
1110
 
Since 2.24</para>
1111
 
<para>
1112
 
</para><variablelist role="params">
1113
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1114
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1115
 
</simpara></listitem></varlistentry>
1116
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a tuple type
1117
 
</simpara></listitem></varlistentry>
1118
 
</variablelist></refsect2>
1119
 
<refsect2 id="g-variant-type-is-dict-entry" role="function">
1120
 
<title>g_variant_type_is_dict_entry ()</title>
1121
 
<indexterm zone="g-variant-type-is-dict-entry"><primary sortas="variant_type_is_dict_entry">g_variant_type_is_dict_entry</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_dict_entry        (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1122
 
<para>
1123
 
Determines if the given <parameter>type</parameter> is a dictionary entry type.  This is
1124
 
true if the type string for <parameter>type</parameter> starts with a '{'.
1125
 
</para>
1126
 
<para>
1127
 
This function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> for any indefinite type for which every
1128
 
definite subtype is a dictionary entry type --
1129
 
<link linkend="G-VARIANT-TYPE-DICT-ENTRY--CAPS"><literal>G_VARIANT_TYPE_DICT_ENTRY</literal></link>, for example.
1130
 
</para>
1131
 
<para>
1132
 
Since 2.24</para>
1133
 
<para>
1134
 
</para><variablelist role="params">
1135
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1136
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1137
 
</simpara></listitem></varlistentry>
1138
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a dictionary entry type
1139
 
</simpara></listitem></varlistentry>
1140
 
</variablelist></refsect2>
1141
 
<refsect2 id="g-variant-type-is-variant" role="function">
1142
 
<title>g_variant_type_is_variant ()</title>
1143
 
<indexterm zone="g-variant-type-is-variant"><primary sortas="variant_type_is_variant">g_variant_type_is_variant</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_variant           (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1144
 
<para>
1145
 
Determines if the given <parameter>type</parameter> is the variant type.
1146
 
</para>
1147
 
<para>
1148
 
Since 2.24</para>
1149
 
<para>
1150
 
</para><variablelist role="params">
1151
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1152
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1153
 
</simpara></listitem></varlistentry>
1154
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is the variant type
1155
 
</simpara></listitem></varlistentry>
1156
 
</variablelist></refsect2>
1157
 
<refsect2 id="g-variant-type-hash" role="function">
1158
 
<title>g_variant_type_hash ()</title>
1159
 
<indexterm zone="g-variant-type-hash"><primary sortas="variant_type_hash">g_variant_type_hash</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_variant_type_hash                 (<link linkend="gconstpointer">gconstpointer</link> type);</programlisting>
1160
 
<para>
1161
 
Hashes <parameter>type</parameter>.
1162
 
</para>
1163
 
<para>
1164
 
The argument type of <parameter>type</parameter> is only <link linkend="gconstpointer"><type>gconstpointer</type></link> to allow use with
1165
 
<link linkend="GHashTable"><type>GHashTable</type></link> without function pointer casting.  A valid
1166
 
<link linkend="GVariantType"><type>GVariantType</type></link> must be provided.
1167
 
</para>
1168
 
<para>
1169
 
Since 2.24</para>
1170
 
<para>
1171
 
</para><variablelist role="params">
1172
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1173
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1174
 
</simpara></listitem></varlistentry>
1175
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the hash value
1176
 
</simpara></listitem></varlistentry>
1177
 
</variablelist></refsect2>
1178
 
<refsect2 id="g-variant-type-equal" role="function">
1179
 
<title>g_variant_type_equal ()</title>
1180
 
<indexterm zone="g-variant-type-equal"><primary sortas="variant_type_equal">g_variant_type_equal</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_equal                (<link linkend="gconstpointer">gconstpointer</link> type1,
1181
 
                                                         <link linkend="gconstpointer">gconstpointer</link> type2);</programlisting>
1182
 
<para>
1183
 
Compares <parameter>type1</parameter> and <parameter>type2</parameter> for equality.
1184
 
</para>
1185
 
<para>
1186
 
Only returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the types are exactly equal.  Even if one type
1187
 
is an indefinite type and the other is a subtype of it, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> will
1188
 
be returned if they are not exactly equal.  If you want to check for
1189
 
subtypes, use <link linkend="g-variant-type-is-subtype-of"><function>g_variant_type_is_subtype_of()</function></link>.
1190
 
</para>
1191
 
<para>
1192
 
The argument types of <parameter>type1</parameter> and <parameter>type2</parameter> are only <link linkend="gconstpointer"><type>gconstpointer</type></link> to
1193
 
allow use with <link linkend="GHashTable"><type>GHashTable</type></link> without function pointer casting.  For
1194
 
both arguments, a valid <link linkend="GVariantType"><type>GVariantType</type></link> must be provided.
1195
 
</para>
1196
 
<para>
1197
 
Since 2.24</para>
1198
 
<para>
1199
 
</para><variablelist role="params">
1200
 
<varlistentry><term><parameter>type1</parameter>&#160;:</term>
1201
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1202
 
</simpara></listitem></varlistentry>
1203
 
<varlistentry><term><parameter>type2</parameter>&#160;:</term>
1204
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1205
 
</simpara></listitem></varlistentry>
1206
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type1</parameter> and <parameter>type2</parameter> are exactly equal
1207
 
</simpara></listitem></varlistentry>
1208
 
</variablelist></refsect2>
1209
 
<refsect2 id="g-variant-type-is-subtype-of" role="function">
1210
 
<title>g_variant_type_is_subtype_of ()</title>
1211
 
<indexterm zone="g-variant-type-is-subtype-of"><primary sortas="variant_type_is_subtype_of">g_variant_type_is_subtype_of</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_variant_type_is_subtype_of        (const <link linkend="GVariantType">GVariantType</link> *type,
1212
 
                                                         const <link linkend="GVariantType">GVariantType</link> *supertype);</programlisting>
1213
 
<para>
1214
 
Checks if <parameter>type</parameter> is a subtype of <parameter>supertype</parameter>.
1215
 
</para>
1216
 
<para>
1217
 
This function returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a subtype of <parameter>supertype</parameter>.  All
1218
 
types are considered to be subtypes of themselves.  Aside from that,
1219
 
only indefinite types can have subtypes.
1220
 
</para>
1221
 
<para>
1222
 
Since 2.24</para>
1223
 
<para>
1224
 
</para><variablelist role="params">
1225
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1226
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1227
 
</simpara></listitem></varlistentry>
1228
 
<varlistentry><term><parameter>supertype</parameter>&#160;:</term>
1229
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1230
 
</simpara></listitem></varlistentry>
1231
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if <parameter>type</parameter> is a subtype of <parameter>supertype</parameter>
1232
 
</simpara></listitem></varlistentry>
1233
 
</variablelist></refsect2>
1234
 
<refsect2 id="g-variant-type-new-maybe" role="function">
1235
 
<title>g_variant_type_new_maybe ()</title>
1236
 
<indexterm zone="g-variant-type-new-maybe"><primary sortas="variant_type_new_maybe">g_variant_type_new_maybe</primary></indexterm><programlisting><link linkend="GVariantType">GVariantType</link> *      g_variant_type_new_maybe            (const <link linkend="GVariantType">GVariantType</link> *element);</programlisting>
1237
 
<para>
1238
 
Constructs the type corresponding to a maybe instance containing
1239
 
type <parameter>type</parameter> or Nothing.
1240
 
</para>
1241
 
<para>
1242
 
It is appropriate to call <link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link> on the return value.
1243
 
</para>
1244
 
<para>
1245
 
Since 2.24</para>
1246
 
<para>
1247
 
</para><variablelist role="params">
1248
 
<varlistentry><term><parameter>element</parameter>&#160;:</term>
1249
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1250
 
</simpara></listitem></varlistentry>
1251
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new maybe <link linkend="GVariantType"><type>GVariantType</type></link>
1252
 
</simpara></listitem></varlistentry>
1253
 
</variablelist></refsect2>
1254
 
<refsect2 id="g-variant-type-new-array" role="function">
1255
 
<title>g_variant_type_new_array ()</title>
1256
 
<indexterm zone="g-variant-type-new-array"><primary sortas="variant_type_new_array">g_variant_type_new_array</primary></indexterm><programlisting><link linkend="GVariantType">GVariantType</link> *      g_variant_type_new_array            (const <link linkend="GVariantType">GVariantType</link> *element);</programlisting>
1257
 
<para>
1258
 
Constructs the type corresponding to an array of elements of the
1259
 
type <parameter>type</parameter>.
1260
 
</para>
1261
 
<para>
1262
 
It is appropriate to call <link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link> on the return value.
1263
 
</para>
1264
 
<para>
1265
 
Since 2.24</para>
1266
 
<para>
1267
 
</para><variablelist role="params">
1268
 
<varlistentry><term><parameter>element</parameter>&#160;:</term>
1269
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1270
 
</simpara></listitem></varlistentry>
1271
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new array <link linkend="GVariantType"><type>GVariantType</type></link>
1272
 
</simpara></listitem></varlistentry>
1273
 
</variablelist></refsect2>
1274
 
<refsect2 id="g-variant-type-new-tuple" role="function">
1275
 
<title>g_variant_type_new_tuple ()</title>
1276
 
<indexterm zone="g-variant-type-new-tuple"><primary sortas="variant_type_new_tuple">g_variant_type_new_tuple</primary></indexterm><programlisting><link linkend="GVariantType">GVariantType</link> *      g_variant_type_new_tuple            (const <link linkend="GVariantType">GVariantType</link> * const *items,
1277
 
                                                         <link linkend="gint">gint</link> length);</programlisting>
1278
 
<para>
1279
 
Constructs a new tuple type, from <parameter>items</parameter>.
1280
 
</para>
1281
 
<para>
1282
 
<parameter>length</parameter> is the number of items in <parameter>items</parameter>, or -1 to indicate that
1283
 
<parameter>items</parameter> is <link linkend="NULL--CAPS"><literal>NULL</literal></link>-terminated.
1284
 
</para>
1285
 
<para>
1286
 
It is appropriate to call <link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link> on the return value.
1287
 
</para>
1288
 
<para>
1289
 
Since 2.24</para>
1290
 
<para>
1291
 
</para><variablelist role="params">
1292
 
<varlistentry><term><parameter>items</parameter>&#160;:</term>
1293
 
<listitem><simpara> an array of <link linkend="GVariantTypes"><type>GVariantTypes</type></link>, one for each item
1294
 
</simpara></listitem></varlistentry>
1295
 
<varlistentry><term><parameter>length</parameter>&#160;:</term>
1296
 
<listitem><simpara> the length of <parameter>items</parameter>, or -1
1297
 
</simpara></listitem></varlistentry>
1298
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new tuple <link linkend="GVariantType"><type>GVariantType</type></link>
1299
 
</simpara></listitem></varlistentry>
1300
 
</variablelist></refsect2>
1301
 
<refsect2 id="g-variant-type-new-dict-entry" role="function">
1302
 
<title>g_variant_type_new_dict_entry ()</title>
1303
 
<indexterm zone="g-variant-type-new-dict-entry"><primary sortas="variant_type_new_dict_entry">g_variant_type_new_dict_entry</primary></indexterm><programlisting><link linkend="GVariantType">GVariantType</link> *      g_variant_type_new_dict_entry       (const <link linkend="GVariantType">GVariantType</link> *key,
1304
 
                                                         const <link linkend="GVariantType">GVariantType</link> *value);</programlisting>
1305
 
<para>
1306
 
Constructs the type corresponding to a dictionary entry with a key
1307
 
of type <parameter>key</parameter> and a value of type <parameter>value</parameter>.
1308
 
</para>
1309
 
<para>
1310
 
It is appropriate to call <link linkend="g-variant-type-free"><function>g_variant_type_free()</function></link> on the return value.
1311
 
</para>
1312
 
<para>
1313
 
Since 2.24</para>
1314
 
<para>
1315
 
</para><variablelist role="params">
1316
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
1317
 
<listitem><simpara> a basic <link linkend="GVariantType"><type>GVariantType</type></link>
1318
 
</simpara></listitem></varlistentry>
1319
 
<varlistentry><term><parameter>value</parameter>&#160;:</term>
1320
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link>
1321
 
</simpara></listitem></varlistentry>
1322
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new dictionary entry <link linkend="GVariantType"><type>GVariantType</type></link>
1323
 
</simpara></listitem></varlistentry>
1324
 
</variablelist></refsect2>
1325
 
<refsect2 id="g-variant-type-element" role="function">
1326
 
<title>g_variant_type_element ()</title>
1327
 
<indexterm zone="g-variant-type-element"><primary sortas="variant_type_element">g_variant_type_element</primary></indexterm><programlisting>const <link linkend="GVariantType">GVariantType</link> * g_variant_type_element             (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1328
 
<para>
1329
 
Determines the element type of an array or maybe type.
1330
 
</para>
1331
 
<para>
1332
 
This function may only be used with array or maybe types.
1333
 
</para>
1334
 
<para>
1335
 
Since 2.24</para>
1336
 
<para>
1337
 
</para><variablelist role="params">
1338
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1339
 
<listitem><simpara> an array or maybe <link linkend="GVariantType"><type>GVariantType</type></link>
1340
 
</simpara></listitem></varlistentry>
1341
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the element type of <parameter>type</parameter>
1342
 
</simpara></listitem></varlistentry>
1343
 
</variablelist></refsect2>
1344
 
<refsect2 id="g-variant-type-n-items" role="function">
1345
 
<title>g_variant_type_n_items ()</title>
1346
 
<indexterm zone="g-variant-type-n-items"><primary sortas="variant_type_n_items">g_variant_type_n_items</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               g_variant_type_n_items              (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1347
 
<para>
1348
 
Determines the number of items contained in a tuple or
1349
 
dictionary entry type.
1350
 
</para>
1351
 
<para>
1352
 
This function may only be used with tuple or dictionary entry types,
1353
 
but must not be used with the generic tuple type
1354
 
<link linkend="G-VARIANT-TYPE-TUPLE--CAPS"><literal>G_VARIANT_TYPE_TUPLE</literal></link>.
1355
 
</para>
1356
 
<para>
1357
 
In the case of a dictionary entry type, this function will always
1358
 
return 2.
1359
 
</para>
1360
 
<para>
1361
 
Since 2.24</para>
1362
 
<para>
1363
 
</para><variablelist role="params">
1364
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1365
 
<listitem><simpara> a tuple or dictionary entry <link linkend="GVariantType"><type>GVariantType</type></link>
1366
 
</simpara></listitem></varlistentry>
1367
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of items in <parameter>type</parameter>
1368
 
</simpara></listitem></varlistentry>
1369
 
</variablelist></refsect2>
1370
 
<refsect2 id="g-variant-type-first" role="function">
1371
 
<title>g_variant_type_first ()</title>
1372
 
<indexterm zone="g-variant-type-first"><primary sortas="variant_type_first">g_variant_type_first</primary></indexterm><programlisting>const <link linkend="GVariantType">GVariantType</link> * g_variant_type_first               (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1373
 
<para>
1374
 
Determines the first item type of a tuple or dictionary entry
1375
 
type.
1376
 
</para>
1377
 
<para>
1378
 
This function may only be used with tuple or dictionary entry types,
1379
 
but must not be used with the generic tuple type
1380
 
<link linkend="G-VARIANT-TYPE-TUPLE--CAPS"><literal>G_VARIANT_TYPE_TUPLE</literal></link>.
1381
 
</para>
1382
 
<para>
1383
 
In the case of a dictionary entry type, this returns the type of
1384
 
the key.
1385
 
</para>
1386
 
<para>
1387
 
<link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned in case of <parameter>type</parameter> being <link linkend="G-VARIANT-TYPE-UNIT--CAPS"><literal>G_VARIANT_TYPE_UNIT</literal></link>.
1388
 
</para>
1389
 
<para>
1390
 
This call, together with <link linkend="g-variant-type-next"><function>g_variant_type_next()</function></link> provides an iterator
1391
 
interface over tuple and dictionary entry types.
1392
 
</para>
1393
 
<para>
1394
 
Since 2.24</para>
1395
 
<para>
1396
 
</para><variablelist role="params">
1397
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1398
 
<listitem><simpara> a tuple or dictionary entry <link linkend="GVariantType"><type>GVariantType</type></link>
1399
 
</simpara></listitem></varlistentry>
1400
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the first item type of <parameter>type</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1401
 
</simpara></listitem></varlistentry>
1402
 
</variablelist></refsect2>
1403
 
<refsect2 id="g-variant-type-next" role="function">
1404
 
<title>g_variant_type_next ()</title>
1405
 
<indexterm zone="g-variant-type-next"><primary sortas="variant_type_next">g_variant_type_next</primary></indexterm><programlisting>const <link linkend="GVariantType">GVariantType</link> * g_variant_type_next                (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1406
 
<para>
1407
 
Determines the next item type of a tuple or dictionary entry
1408
 
type.
1409
 
</para>
1410
 
<para>
1411
 
<parameter>type</parameter> must be the result of a previous call to
1412
 
<link linkend="g-variant-type-first"><function>g_variant_type_first()</function></link> or <link linkend="g-variant-type-next"><function>g_variant_type_next()</function></link>.
1413
 
</para>
1414
 
<para>
1415
 
If called on the key type of a dictionary entry then this call
1416
 
returns the value type.  If called on the value type of a dictionary
1417
 
entry then this call returns <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
1418
 
</para>
1419
 
<para>
1420
 
For tuples, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned when <parameter>type</parameter> is the last item in a tuple.
1421
 
</para>
1422
 
<para>
1423
 
Since 2.24</para>
1424
 
<para>
1425
 
</para><variablelist role="params">
1426
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1427
 
<listitem><simpara> a <link linkend="GVariantType"><type>GVariantType</type></link> from a previous call
1428
 
</simpara></listitem></varlistentry>
1429
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the next <link linkend="GVariantType"><type>GVariantType</type></link> after <parameter>type</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
1430
 
</simpara></listitem></varlistentry>
1431
 
</variablelist></refsect2>
1432
 
<refsect2 id="g-variant-type-key" role="function">
1433
 
<title>g_variant_type_key ()</title>
1434
 
<indexterm zone="g-variant-type-key"><primary sortas="variant_type_key">g_variant_type_key</primary></indexterm><programlisting>const <link linkend="GVariantType">GVariantType</link> * g_variant_type_key                 (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1435
 
<para>
1436
 
Determines the key type of a dictionary entry type.
1437
 
</para>
1438
 
<para>
1439
 
This function may only be used with a dictionary entry type.  Other
1440
 
than the additional restriction, this call is equivalent to
1441
 
<link linkend="g-variant-type-first"><function>g_variant_type_first()</function></link>.
1442
 
</para>
1443
 
<para>
1444
 
Since 2.24</para>
1445
 
<para>
1446
 
</para><variablelist role="params">
1447
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1448
 
<listitem><simpara> a dictionary entry <link linkend="GVariantType"><type>GVariantType</type></link>
1449
 
</simpara></listitem></varlistentry>
1450
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the key type of the dictionary entry
1451
 
</simpara></listitem></varlistentry>
1452
 
</variablelist></refsect2>
1453
 
<refsect2 id="g-variant-type-value" role="function">
1454
 
<title>g_variant_type_value ()</title>
1455
 
<indexterm zone="g-variant-type-value"><primary sortas="variant_type_value">g_variant_type_value</primary></indexterm><programlisting>const <link linkend="GVariantType">GVariantType</link> * g_variant_type_value               (const <link linkend="GVariantType">GVariantType</link> *type);</programlisting>
1456
 
<para>
1457
 
Determines the value type of a dictionary entry type.
1458
 
</para>
1459
 
<para>
1460
 
This function may only be used with a dictionary entry type.
1461
 
</para>
1462
 
<para>
1463
 
Since 2.24</para>
1464
 
<para>
1465
 
</para><variablelist role="params">
1466
 
<varlistentry><term><parameter>type</parameter>&#160;:</term>
1467
 
<listitem><simpara> a dictionary entry <link linkend="GVariantType"><type>GVariantType</type></link>
1468
 
</simpara></listitem></varlistentry>
1469
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the value type of the dictionary entry
1470
 
</simpara></listitem></varlistentry>
1471
 
</variablelist></refsect2>
1472
 
 
1473
 
</refsect1>
1474
 
 
1475
 
 
1476
 
 
1477
 
<refsect1 id="glib-GVariantType.see-also">
1478
 
<title>See Also</title>
1479
 
#GVariantType, <link linkend="GVariant"><type>GVariant</type></link>
1480
 
</refsect1>
1481
 
 
1482
 
</refentry>