docs/reference/gobject/tmpl/value_collection.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Varargs Value Collection
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Converting varargs to generic values
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### UNION GTypeCValue ##### -->
  18 <para>
  19 A union holding one collected value.
  20 </para>
  21
  22
  23 <!-- ##### MACRO G_VALUE_COLLECT ##### -->
  24 <para>
  25 Collects a variable argument value from a va_list. We have to
  26 implement the varargs collection as a macro, because on some systems
  27 va_list variables cannot be passed by reference.
  28 </para>
  29
  30 @value: a #GValue return location. @value is supposed to be initialized
  31   according to the value type to be collected
  32 @var_args: the va_list variable; it may be evaluated multiple times
  33 @flags: flags which are passed on to the collect_value() function of
  34   the #GTypeValueTable of @value.
  35 @__error: a #gchar** variable that will be modified to hold a g_new()
  36   allocated error messages if something fails
  37
  38
  39 <!-- ##### MACRO G_VALUE_LCOPY ##### -->
  40 <para>
  41 Collects a value's variable argument locations from a va_list.
  42 </para>
  43
  44 @value: a #GValue return location. @value is supposed to be initialized
  45   according to the value type to be collected
  46 @var_args: the va_list variable; it may be evaluated multiple times
  47 @flags: flags which are passed on to the lcopy_value() function of
  48   the #GTypeValueTable of @value.
  49 @__error: a #gchar** variable that will be modified to hold a g_new()
  50   allocated error messages if something fails
  51
  52
  53 <!-- ##### MACRO G_VALUE_COLLECT_FORMAT_MAX_LENGTH ##### -->
  54 <para>
  55 The maximal number of #GTypeCValue<!-- -->s which can be collected for a
  56 single #GValue.
  57 </para>
  58
  59
  60