luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-01 15:03:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Migrating docs.

Browse Source 
* docs/reference/gobject/tmpl/value_collection.sgml:
	* gobject/gvaluecollector.h:
	  Migrating docs.


svn path=/trunk/; revision=7086
This commit is contained in:
Stefan Kost
2008-06-22 09:53:11 +00:00
parent 80326e2433
commit 43c995df17
3 changed files with 53 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
docs/reference/gobject/tmpl/value_collection.sgml
View File

@@ -1,66 +0,0 @@
<!-- ##### SECTION Title ##### -->
Varargs Value Collection
<!-- ##### SECTION Short_Description ##### -->
Converting varargs to generic values
<!-- ##### SECTION Long_Description ##### -->
<para>
The macros in this section provide the varargs parsing support needed
in variadic GObject functions such as g_object_new() or g_object_set().
They currently support the collection of integral types, floating point
types and pointers.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
#GValueTable
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### UNION GTypeCValue ##### -->
<para>
A union holding one collected value.
</para>
<!-- ##### MACRO G_VALUE_COLLECT ##### -->
<para>
Collects a variable argument value from a va_list. We have to
implement the varargs collection as a macro, because on some systems
va_list variables cannot be passed by reference.
</para>
@value: a #GValue return location. @value is supposed to be initialized
according to the value type to be collected
@var_args: the va_list variable; it may be evaluated multiple times
@flags: flags which are passed on to the collect_value() function of
the #GTypeValueTable of @value.
@__error: a #gchar** variable that will be modified to hold a g_new()
allocated error messages if something fails
<!-- ##### MACRO G_VALUE_LCOPY ##### -->
<para>
Collects a value's variable argument locations from a va_list.
</para>
@value: a #GValue return location. @value is supposed to be initialized
according to the value type to be collected
@var_args: the va_list variable; it may be evaluated multiple times
@flags: flags which are passed on to the lcopy_value() function of
the #GTypeValueTable of @value.
@__error: a #gchar** variable that will be modified to hold a g_new()
allocated error messages if something fails
<!-- ##### MACRO G_VALUE_COLLECT_FORMAT_MAX_LENGTH ##### -->
<para>
The maximal number of #GTypeCValue<!-- -->s which can be collected for a
single #GValue.
</para>