~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GDBusMethodInvocation.html

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2014-03-24 20:58:34 UTC
  • mfrom: (1.66.13)
  • Revision ID: package-import@ubuntu.com-20140324205834-8hsgok8k36ftocqa
Tags: 2.40.0-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
41
41
</colgroup>
42
42
<tbody>
43
43
<tr>
44
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
44
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
45
45
</td>
46
46
<td class="function_name">
47
47
<a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-sender" title="g_dbus_method_invocation_get_sender ()">g_dbus_method_invocation_get_sender</a> <span class="c_punctuation">()</span>
48
48
</td>
49
49
</tr>
50
50
<tr>
51
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
51
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
52
52
</td>
53
53
<td class="function_name">
54
54
<a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-object-path" title="g_dbus_method_invocation_get_object_path ()">g_dbus_method_invocation_get_object_path</a> <span class="c_punctuation">()</span>
55
55
</td>
56
56
</tr>
57
57
<tr>
58
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
58
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
59
59
</td>
60
60
<td class="function_name">
61
61
<a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-interface-name" title="g_dbus_method_invocation_get_interface_name ()">g_dbus_method_invocation_get_interface_name</a> <span class="c_punctuation">()</span>
62
62
</td>
63
63
</tr>
64
64
<tr>
65
 
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
65
<td class="function_type">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
66
66
</td>
67
67
<td class="function_name">
68
68
<a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-method-name" title="g_dbus_method_invocation_get_method_name ()">g_dbus_method_invocation_get_method_name</a> <span class="c_punctuation">()</span>
100
100
</tr>
101
101
<tr>
102
102
<td class="function_type">
103
 
<a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 
103
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
104
104
</td>
105
105
<td class="function_name">
106
106
<a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-parameters" title="g_dbus_method_invocation_get_parameters ()">g_dbus_method_invocation_get_parameters</a> <span class="c_punctuation">()</span>
108
108
</tr>
109
109
<tr>
110
110
<td class="function_type">
111
 
<a href="../glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
 
111
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
112
112
</td>
113
113
<td class="function_name">
114
114
<a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-user-data" title="g_dbus_method_invocation_get_user_data ()">g_dbus_method_invocation_get_user_data</a> <span class="c_punctuation">()</span>
196
196
</div>
197
197
<div class="refsect1">
198
198
<a name="GDBusMethodInvocation.object-hierarchy"></a><h2>Object Hierarchy</h2>
199
 
<pre class="screen">    <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
199
<pre class="screen">    <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
200
200
    <span class="lineart">╰──</span> GDBusMethodInvocation
201
201
</pre>
202
202
</div>
218
218
<a name="GDBusMethodInvocation.functions_details"></a><h2>Functions</h2>
219
219
<div class="refsect2">
220
220
<a name="g-dbus-method-invocation-get-sender"></a><h3>g_dbus_method_invocation_get_sender ()</h3>
221
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
221
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
222
222
g_dbus_method_invocation_get_sender (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
223
223
<p>Gets the bus name that invoked the method.</p>
224
224
<div class="refsect3">
247
247
<hr>
248
248
<div class="refsect2">
249
249
<a name="g-dbus-method-invocation-get-object-path"></a><h3>g_dbus_method_invocation_get_object_path ()</h3>
250
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
250
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
251
251
g_dbus_method_invocation_get_object_path
252
252
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
253
253
<p>Gets the object path the method was invoked on.</p>
277
277
<hr>
278
278
<div class="refsect2">
279
279
<a name="g-dbus-method-invocation-get-interface-name"></a><h3>g_dbus_method_invocation_get_interface_name ()</h3>
280
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
280
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
281
281
g_dbus_method_invocation_get_interface_name
282
282
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
283
283
<p>Gets the name of the D-Bus interface the method was invoked on.</p>
311
311
<hr>
312
312
<div class="refsect2">
313
313
<a name="g-dbus-method-invocation-get-method-name"></a><h3>g_dbus_method_invocation_get_method_name ()</h3>
314
 
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 
314
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
315
315
g_dbus_method_invocation_get_method_name
316
316
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
317
317
<p>Gets the name of the method that was invoked.</p>
346
346
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
347
347
<p>Gets information about the method call, if any.</p>
348
348
<p>If this method invocation is a property Get, Set or GetAll call that
349
 
has been redirected to the method call handler then <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be
 
349
has been redirected to the method call handler then <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be
350
350
returned.  See <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-get-property-info" title="g_dbus_method_invocation_get_property_info ()"><code class="function">g_dbus_method_invocation_get_property_info()</code></a> and
351
351
<a class="link" href="GDBusConnection.html#GDBusInterfaceVTable" title="GDBusInterfaceVTable"><span class="type">GDBusInterfaceVTable</span></a> for more information.</p>
352
352
<div class="refsect3">
366
366
</div>
367
367
<div class="refsect3">
368
368
<a name="id-1.4.17.8.8.6.7"></a><h4>Returns</h4>
369
 
<p> A <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusMethodInfo"><span class="type">GDBusMethodInfo</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not free, it is owned by <em class="parameter"><code>invocation</code></em>
 
369
<p> A <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusMethodInfo"><span class="type">GDBusMethodInfo</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. Do not free, it is owned by <em class="parameter"><code>invocation</code></em>
370
370
.</p>
371
371
<p></p>
372
372
</div>
385
385
handler for an object on account of its <code class="function">property_get()</code> or
386
386
<code class="function">property_set()</code> vtable pointers being unset.</p>
387
387
<p>See <a class="link" href="GDBusConnection.html#GDBusInterfaceVTable" title="GDBusInterfaceVTable"><span class="type">GDBusInterfaceVTable</span></a> for more information.</p>
388
 
<p>If the call was GetAll, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.</p>
 
388
<p>If the call was GetAll, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> will be returned.</p>
389
389
<div class="refsect3">
390
390
<a name="id-1.4.17.8.8.7.8"></a><h4>Parameters</h4>
391
391
<div class="informaltable"><table width="100%" border="0">
403
403
</div>
404
404
<div class="refsect3">
405
405
<a name="id-1.4.17.8.8.7.9"></a><h4>Returns</h4>
406
 
<p> a <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusPropertyInfo"><span class="type">GDBusPropertyInfo</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
 
406
<p> a <a class="link" href="gio-D-Bus-Introspection-Data.html#GDBusPropertyInfo"><span class="type">GDBusPropertyInfo</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p>
407
407
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
408
408
</div>
409
409
<p class="since">Since 2.38</p>
446
446
<p>Gets the <a class="link" href="GDBusMessage.html" title="GDBusMessage"><span class="type">GDBusMessage</span></a> for the method invocation. This is useful if
447
447
you need to use low-level protocol features, such as UNIX file
448
448
descriptor passing, that cannot be properly expressed in the
449
 
<a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> API.</p>
 
449
<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> API.</p>
450
450
<p>See this <a class="link" href="GDBusConnection.html#gdbus-server" title="An example D-Bus server">server</a> and <a class="link" href="GDBusConnection.html#gdbus-unix-fd-client" title="An example for file descriptor passing">client</a>
451
451
for an example of how to use this low-level API to send and receive
452
452
UNIX file descriptors.</p>
476
476
<hr>
477
477
<div class="refsect2">
478
478
<a name="g-dbus-method-invocation-get-parameters"></a><h3>g_dbus_method_invocation_get_parameters ()</h3>
479
 
<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 
479
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
480
480
g_dbus_method_invocation_get_parameters
481
481
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
482
482
<p>Gets the parameters of the method invocation. If there are no input
498
498
</div>
499
499
<div class="refsect3">
500
500
<a name="id-1.4.17.8.8.10.6"></a><h4>Returns</h4>
501
 
<p> A <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple. Do not unref this because it is owned by <em class="parameter"><code>invocation</code></em>
 
501
<p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple. Do not unref this because it is owned by <em class="parameter"><code>invocation</code></em>
502
502
. </p>
503
503
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
504
504
</div>
507
507
<hr>
508
508
<div class="refsect2">
509
509
<a name="g-dbus-method-invocation-get-user-data"></a><h3>g_dbus_method_invocation_get_user_data ()</h3>
510
 
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
 
510
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="returnvalue">gpointer</span></a>
511
511
g_dbus_method_invocation_get_user_data
512
512
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>);</pre>
513
513
<p>Gets the <em class="parameter"><code>user_data</code></em>
514
 
 <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> passed to <a class="link" href="GDBusConnection.html#g-dbus-connection-register-object" title="g_dbus_connection_register_object ()"><code class="function">g_dbus_connection_register_object()</code></a>.</p>
 
514
 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> passed to <a class="link" href="GDBusConnection.html#g-dbus-connection-register-object" title="g_dbus_connection_register_object ()"><code class="function">g_dbus_connection_register_object()</code></a>.</p>
515
515
<div class="refsect3">
516
516
<a name="id-1.4.17.8.8.11.5"></a><h4>Parameters</h4>
517
517
<div class="informaltable"><table width="100%" border="0">
529
529
</div>
530
530
<div class="refsect3">
531
531
<a name="id-1.4.17.8.8.11.6"></a><h4>Returns</h4>
532
 
<p> A <a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>.</p>
 
532
<p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>.</p>
533
533
<p></p>
534
534
</div>
535
535
<p class="since">Since 2.26</p>
539
539
<a name="g-dbus-method-invocation-return-value"></a><h3>g_dbus_method_invocation_return_value ()</h3>
540
540
<pre class="programlisting"><span class="returnvalue">void</span>
541
541
g_dbus_method_invocation_return_value (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
542
 
                                       <em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *parameters</code></em>);</pre>
 
542
                                       <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *parameters</code></em>);</pre>
543
543
<p>Finishes handling a D-Bus method call by returning <em class="parameter"><code>parameters</code></em>
544
544
.
545
545
If the <em class="parameter"><code>parameters</code></em>
564
564
</tr>
565
565
<tr>
566
566
<td class="parameter_name"><p>parameters</p></td>
567
 
<td class="parameter_description"><p> A <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple with out parameters for the method or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not passing any parameters. </p></td>
 
567
<td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple with out parameters for the method or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not passing any parameters. </p></td>
568
568
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
569
569
</tr>
570
570
</tbody>
577
577
<a name="g-dbus-method-invocation-return-error"></a><h3>g_dbus_method_invocation_return_error ()</h3>
578
578
<pre class="programlisting"><span class="returnvalue">void</span>
579
579
g_dbus_method_invocation_return_error (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
580
 
                                       <em class="parameter"><code><a href="../glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
581
 
                                       <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
582
 
                                       <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
 
580
                                       <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
 
581
                                       <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
 
582
                                       <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
583
583
                                       <em class="parameter"><code>...</code></em>);</pre>
584
584
<p>Finishes handling a D-Bus method call by returning an error.</p>
585
585
<p>See <a class="link" href="gio-GDBusError.html#g-dbus-error-encode-gerror" title="g_dbus_error_encode_gerror ()"><code class="function">g_dbus_error_encode_gerror()</code></a> for details about what error name
587
587
registered using <a class="link" href="gio-GDBusError.html#g-dbus-error-register-error" title="g_dbus_error_register_error ()"><code class="function">g_dbus_error_register_error()</code></a> the name given
588
588
during registration is used. Otherwise, a name of the form
589
589
<code class="literal">org.gtk.GDBus.UnmappedGError.Quark...</code> is used. This provides
590
 
transparent mapping of <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> between applications using GDBus.</p>
 
590
transparent mapping of <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> between applications using GDBus.</p>
591
591
<p>If you are writing an application intended to be portable,
592
592
always register errors with <a class="link" href="gio-GDBusError.html#g-dbus-error-register-error" title="g_dbus_error_register_error ()"><code class="function">g_dbus_error_register_error()</code></a>
593
593
or use <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-dbus-error" title="g_dbus_method_invocation_return_dbus_error ()"><code class="function">g_dbus_method_invocation_return_dbus_error()</code></a>.</p>
609
609
</tr>
610
610
<tr>
611
611
<td class="parameter_name"><p>domain</p></td>
612
 
<td class="parameter_description"><p>A <a href="../glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for the <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> error domain.</p></td>
 
612
<td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for the <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> error domain.</p></td>
613
613
<td class="parameter_annotations"> </td>
614
614
</tr>
615
615
<tr>
639
639
<pre class="programlisting"><span class="returnvalue">void</span>
640
640
g_dbus_method_invocation_return_error_valist
641
641
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
642
 
                                <em class="parameter"><code><a href="../glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
643
 
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
644
 
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
 
642
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
 
643
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
 
644
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
645
645
                                <em class="parameter"><code><span class="type">va_list</span> var_args</code></em>);</pre>
646
646
<p>Like <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-error" title="g_dbus_method_invocation_return_error ()"><code class="function">g_dbus_method_invocation_return_error()</code></a> but intended for
647
647
language bindings.</p>
663
663
</tr>
664
664
<tr>
665
665
<td class="parameter_name"><p>domain</p></td>
666
 
<td class="parameter_description"><p>A <a href="../glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for the <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> error domain.</p></td>
 
666
<td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for the <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> error domain.</p></td>
667
667
<td class="parameter_annotations"> </td>
668
668
</tr>
669
669
<tr>
693
693
<pre class="programlisting"><span class="returnvalue">void</span>
694
694
g_dbus_method_invocation_return_error_literal
695
695
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
696
 
                                <em class="parameter"><code><a href="../glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
697
 
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
698
 
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
 
696
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> domain</code></em>,
 
697
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> code</code></em>,
 
698
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *message</code></em>);</pre>
699
699
<p>Like <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-error" title="g_dbus_method_invocation_return_error ()"><code class="function">g_dbus_method_invocation_return_error()</code></a> but without <code class="function">printf()</code>-style formatting.</p>
700
700
<p>This method will free <em class="parameter"><code>invocation</code></em>
701
701
, you cannot use it afterwards.</p>
715
715
</tr>
716
716
<tr>
717
717
<td class="parameter_name"><p>domain</p></td>
718
 
<td class="parameter_description"><p>A <a href="../glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for the <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> error domain.</p></td>
 
718
<td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for the <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> error domain.</p></td>
719
719
<td class="parameter_annotations"> </td>
720
720
</tr>
721
721
<tr>
739
739
<pre class="programlisting"><span class="returnvalue">void</span>
740
740
g_dbus_method_invocation_return_gerror
741
741
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
742
 
                                <em class="parameter"><code>const <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
743
 
<p>Like <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-error" title="g_dbus_method_invocation_return_error ()"><code class="function">g_dbus_method_invocation_return_error()</code></a> but takes a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
 
742
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
 
743
<p>Like <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-error" title="g_dbus_method_invocation_return_error ()"><code class="function">g_dbus_method_invocation_return_error()</code></a> but takes a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>
744
744
instead of the error domain, error code and message.</p>
745
745
<p>This method will free <em class="parameter"><code>invocation</code></em>
746
746
, you cannot use it afterwards.</p>
760
760
</tr>
761
761
<tr>
762
762
<td class="parameter_name"><p>error</p></td>
763
 
<td class="parameter_description"><p>A <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</p></td>
 
763
<td class="parameter_description"><p>A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</p></td>
764
764
<td class="parameter_annotations"> </td>
765
765
</tr>
766
766
</tbody>
774
774
<pre class="programlisting"><span class="returnvalue">void</span>
775
775
g_dbus_method_invocation_return_dbus_error
776
776
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
777
 
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_name</code></em>,
778
 
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_message</code></em>);</pre>
 
777
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_name</code></em>,
 
778
                                <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_message</code></em>);</pre>
779
779
<p>Finishes handling a D-Bus method call by returning an error.</p>
780
780
<p>This method will free <em class="parameter"><code>invocation</code></em>
781
781
, you cannot use it afterwards.</p>
813
813
<a name="g-dbus-method-invocation-take-error"></a><h3>g_dbus_method_invocation_take_error ()</h3>
814
814
<pre class="programlisting"><span class="returnvalue">void</span>
815
815
g_dbus_method_invocation_take_error (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
816
 
                                     <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
 
816
                                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
817
817
<p>Like <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-gerror" title="g_dbus_method_invocation_return_gerror ()"><code class="function">g_dbus_method_invocation_return_gerror()</code></a> but takes ownership
818
818
of <em class="parameter"><code>error</code></em>
819
819
 so the caller does not need to free it.</p>
835
835
</tr>
836
836
<tr>
837
837
<td class="parameter_name"><p>error</p></td>
838
 
<td class="parameter_description"><p> A <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p></td>
 
838
<td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p></td>
839
839
<td class="parameter_annotations"><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td>
840
840
</tr>
841
841
</tbody>
849
849
<pre class="programlisting"><span class="returnvalue">void</span>
850
850
g_dbus_method_invocation_return_value_with_unix_fd_list
851
851
                               (<em class="parameter"><code><a class="link" href="GDBusMethodInvocation.html" title="GDBusMethodInvocation"><span class="type">GDBusMethodInvocation</span></a> *invocation</code></em>,
852
 
                                <em class="parameter"><code><a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *parameters</code></em>,
 
852
                                <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *parameters</code></em>,
853
853
                                <em class="parameter"><code><a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> *fd_list</code></em>);</pre>
854
854
<p>Like <a class="link" href="GDBusMethodInvocation.html#g-dbus-method-invocation-return-value" title="g_dbus_method_invocation_return_value ()"><code class="function">g_dbus_method_invocation_return_value()</code></a> but also takes a <a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a>.</p>
855
855
<p>This method is only available on UNIX.</p>
871
871
</tr>
872
872
<tr>
873
873
<td class="parameter_name"><p>parameters</p></td>
874
 
<td class="parameter_description"><p> A <a href="../glib/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple with out parameters for the method or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not passing any parameters. </p></td>
 
874
<td class="parameter_description"><p> A <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> tuple with out parameters for the method or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if not passing any parameters. </p></td>
875
875
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
876
876
</tr>
877
877
<tr>
878
878
<td class="parameter_name"><p>fd_list</p></td>
879
 
<td class="parameter_description"><p> A <a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
 
879
<td class="parameter_description"><p> A <a class="link" href="GUnixFDList.html" title="GUnixFDList"><span class="type">GUnixFDList</span></a> or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
880
880
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
881
881
</tr>
882
882
</tbody>