mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-12-24 14:36:13 +01:00
GVariant: document avoiding g_variant_iter_loop
The choice between g_variant_iter_next() and g_variant_iter_loop() is a bit confusing for some people. Add a note to the documentation of g_variant_iter_loop() to clarify that it should be avoided except in a few specific cases.
This commit is contained in:
parent
19878998bc
commit
33c977917c
@ -4719,8 +4719,16 @@ g_variant_iter_next (GVariantIter *iter,
|
||||
* </programlisting>
|
||||
* </example>
|
||||
*
|
||||
* If you want a slightly less magical alternative that requires more
|
||||
* typing, see g_variant_iter_next().
|
||||
* For most cases you should use g_variant_iter_next().
|
||||
*
|
||||
* This function is really only useful when unpacking into #GVariant or
|
||||
* #GVariantIter in order to allow you to skip the call to
|
||||
* g_variant_unref() or g_variant_iter_free().
|
||||
*
|
||||
* For example, if you are only looping over simple integer and string
|
||||
* types, g_variant_iter_next() is definitely preferred. For string
|
||||
* types, use the '&' prefix to avoid allocating any memory at all (and
|
||||
* thereby avoiding the need to free anything as well).
|
||||
*
|
||||
* Since: 2.24
|
||||
**/
|
||||
|
Loading…
Reference in New Issue
Block a user