mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-05 08:56:16 +01:00
bc9e9efbaf
2005-05-09 Matthias Clasen <mclasen@redhat.com> * gobject/tmpl/value_collection.sgml: * gobject/tmpl/gboxed.sgml: * gobject/tmpl/enumerations_flags.sgml: * gobject/tmpl/objects.sgml: Add long descriptions.
67 lines
1.9 KiB
Plaintext
67 lines
1.9 KiB
Plaintext
<!-- ##### 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>
|
|
|
|
|
|
|