luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-26 05:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

g_variant_get_fixed_array: document which types are appropriate

Browse Source 
Bug: https://bugzilla.gnome.org/show_bug.cgi?id=632049
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Reviewed-by: Ryan Lortie <desrt@desrt.ca>
This commit is contained in:
Simon McVittie 2010-10-13 12:22:41 +01:00
parent 9e827ab615
commit d34c9bc6f3
1 changed files with 27 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
glib/gvariant.c
View File

@ -94,7 +94,7 @@
* information cache, buffer management memory and memory for the
* #GVariant structure itself.
* </para>
* <refsect3>
* <refsect3 id="gvariant-serialised-data-memory">
* <title>Serialised Data Memory</title>
* <para>
* This is the memory that is used for storing GVariant data in
@ -1055,10 +1055,33 @@ g_variant_lookup_value (GVariant *dictionary,
* items.
*
* @value must be an array with fixed-sized elements. Numeric types are
* fixed-size as are tuples containing only other fixed-sized types.
* fixed-size, as are tuples containing only other fixed-sized types.
*
* @element_size must be the size of a single element in the array. For
* example, if calling this function for an array of 32 bit integers,
* @element_size must be the size of a single element in the array,
* as given by the section on
* <link linkend='gvariant-serialised-data-memory'>Serialised Data
* Memory</link>.
*
* In particular, arrays of these fixed-sized types can be interpreted
* as an array of the given C type, with @element_size set to
* <code>sizeof</code> the appropriate type:
*
* <informaltable>
* <tgroup cols='2'>
* <thead><row><entry>element type</entry> <entry>C type</entry></row></thead>
* <tbody>
* <row><entry>%G_VARIANT_TYPE_INT16 (etc.)</entry>
* <entry>#gint16 (etc.)</entry></row>
* <row><entry>%G_VARIANT_TYPE_BOOLEAN</entry>
* <entry>#guchar (not #gboolean!)</entry></row>
* <row><entry>%G_VARIANT_TYPE_BYTE</entry> <entry>#guchar</entry></row>
* <row><entry>%G_VARIANT_TYPE_HANDLE</entry> <entry>#guint32</entry></row>
* <row><entry>%G_VARIANT_TYPE_DOUBLE</entry> <entry>#gdouble</entry></row>
* </tbody>
* </tgroup>
* </informaltable>
*
* For example, if calling this function for an array of 32 bit integers,
* you might say <code>sizeof (gint32)</code>. This value isn't used
* except for the purpose of a double-check that the form of the
* seralised data matches the caller's expectation.