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

gdbus: Add example to docs for g_dbus_method_invocation_return_value()

Browse Source 
Try to clarify that the variant passed to return_value() must be a
tuple.

https://bugzilla.gnome.org/show_bug.cgi?id=777592
This commit is contained in:
Philip Withnall 2017-01-21 23:41:21 +00:00 committed by Philip Withnall
parent bc8361262b
commit a6e2213343
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
gio/gdbusmethodinvocation.c
View File

@ -534,7 +534,26 @@ g_dbus_method_invocation_return_value_internal (GDBusMethodInvocation *invocatio
* Finishes handling a D-Bus method call by returning @parameters.
* If the @parameters GVariant is floating, it is consumed.
*
* It is an error if @parameters is not of the right format.
* It is an error if @parameters is not of the right format: it must be a tuple
* containing the out-parameters of the D-Bus method. Even if the method has a
* single out-parameter, it must be contained in a tuple. If the method has no
* out-parameters, @parameters may be %NULL or an empty tuple.
*
* |[<!-- language="C" -->
* GDBusMethodInvocation *invocation = some_invocation;
* g_autofree gchar *result_string = NULL;
* g_autoptr (GError) error = NULL;
*
* result_string = calculate_result (&error);
*
* if (error != NULL)
* g_dbus_method_invocation_return_gerror (invocation, error);
* else
* g_dbus_method_invocation_return_value (invocation,
* g_variant_new ("(s)", result_string));
*
* /<!-- -->* Do not free @invocation here; returning a value does that *<!-- -->/
* ]|
*
* This method will take ownership of @invocation. See
* #GDBusInterfaceVTable for more information about the ownership of