~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/gobject/tmpl/value_collection.sgml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

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