This file is indexed.

/usr/share/gtk-doc/html/dbus-glib/dbus-glib-DBusGMethod.html is in libdbus-glib-1-doc 0.108-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DBusGMethod: D-Bus GLib bindings - Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="D-Bus GLib bindings - Reference Manual">
<link rel="up" href="ch02.html" title="API Reference">
<link rel="prev" href="dbus-glib-DBusGMessage.html" title="DBusGMessage">
<link rel="next" href="dbus-glib-DBusGError.html" title="DBusGError">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#dbus-glib-DBusGMethod.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="dbus-glib-DBusGMessage.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="dbus-glib-DBusGError.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="dbus-glib-DBusGMethod"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="dbus-glib-DBusGMethod.top_of_page"></a>DBusGMethod</span></h2>
<p>DBusGMethod — GMethod Info &amp; Invocation</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-get-sender" title="dbus_g_method_get_sender ()">dbus_g_method_get_sender</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">DBusMessage</span> *
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-get-reply" title="dbus_g_method_get_reply ()">dbus_g_method_get_reply</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-send-reply" title="dbus_g_method_send_reply ()">dbus_g_method_send_reply</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-return" title="dbus_g_method_return ()">dbus_g_method_return</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-return-error" title="dbus_g_method_return_error ()">dbus_g_method_return_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInfo" title="struct DBusGMethodInfo">DBusGMethodInfo</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInvocation" title="DBusGMethodInvocation">DBusGMethodInvocation</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;dbus/dbus-glib.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.description"></a><h2>Description</h2>
<p>These types are used to call methods on <span class="type">GObject</span> objects.</p>
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dbus-g-method-get-sender"></a><h3>dbus_g_method_get_sender ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
dbus_g_method_get_sender (<em class="parameter"><code><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInvocation" title="DBusGMethodInvocation"><span class="type">DBusGMethodInvocation</span></a> *context</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_method_get_sender</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. The closest equivalent
 is <code class="function">g_dbus_method_invocation_get_sender()</code>.</p>
</div>
<p>Get the sender of a message so we can send a
"reply" later (i.e. send a message directly
to a service which invoked the method at a
later time).</p>
<div class="refsect3">
<a name="dbus-g-method-get-sender.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>the method context</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dbus-g-method-get-sender.returns"></a><h4>Returns</h4>
<p> the unique name of the sender. It
is up to the caller to free the returned string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-method-get-reply"></a><h3>dbus_g_method_get_reply ()</h3>
<pre class="programlisting"><span class="returnvalue">DBusMessage</span> *
dbus_g_method_get_reply (<em class="parameter"><code><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInvocation" title="DBusGMethodInvocation"><span class="type">DBusGMethodInvocation</span></a> *context</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_method_get_reply</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. The closest equivalent
 is <code class="function">g_dbus_method_invocation_return_value()</code>.</p>
</div>
<p>Get the reply message to append reply values
Used as a sidedoor when you can't generate dbus values
of the correct type due to glib binding limitations</p>
<div class="refsect3">
<a name="dbus-g-method-get-reply.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>the method context</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="dbus-g-method-get-reply.returns"></a><h4>Returns</h4>
<p> a <span class="type">DBusMessage</span> with the reply</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-method-send-reply"></a><h3>dbus_g_method_send_reply ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_method_send_reply (<em class="parameter"><code><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInvocation" title="DBusGMethodInvocation"><span class="type">DBusGMethodInvocation</span></a> *context</code></em>,
                          <em class="parameter"><code><span class="type">DBusMessage</span> *reply</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_method_send_reply</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. The closest equivalent
 is <code class="function">g_dbus_method_invocation_return_value()</code>.</p>
</div>
<p>Send a manually created reply message.</p>
<p>Used as a sidedoor when you can't generate dbus values
of the correct type due to glib binding limitations</p>
<div class="refsect3">
<a name="dbus-g-method-send-reply.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>the method context</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>reply</p></td>
<td class="parameter_description"><p>the reply message, will be unreffed</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-method-return"></a><h3>dbus_g_method_return ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_method_return (<em class="parameter"><code><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInvocation" title="DBusGMethodInvocation"><span class="type">DBusGMethodInvocation</span></a> *context</code></em>,
                      <em class="parameter"><code>...</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_method_return</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. The closest equivalent
 is <code class="function">g_dbus_method_invocation_return_value()</code>.</p>
</div>
<p>Send a return message for a given method invocation, with arguments.
This function also frees the sending context.</p>
<div class="refsect3">
<a name="dbus-g-method-return.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>the method context</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>...</p></td>
<td class="parameter_description"><p>zero or more values to return from the method, with their number
and types given by its <a class="link" href="dbus-glib-DBus-GObject-related-functions.html#DBusGObjectInfo" title="struct DBusGObjectInfo"><span class="type">DBusGObjectInfo</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="dbus-g-method-return-error"></a><h3>dbus_g_method_return_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dbus_g_method_return_error (<em class="parameter"><code><a class="link" href="dbus-glib-DBusGMethod.html#DBusGMethodInvocation" title="DBusGMethodInvocation"><span class="type">DBusGMethodInvocation</span></a> *context</code></em>,
                            <em class="parameter"><code>const <span class="type">GError</span> *error</code></em>);</pre>
<div class="warning">
<p><code class="literal">dbus_g_method_return_error</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. The closest equivalent
 is <code class="function">g_dbus_method_invocation_return_gerror()</code>.</p>
</div>
<p>Send a error message for a given method invocation.
This function also frees the sending context.</p>
<div class="refsect3">
<a name="dbus-g-method-return-error.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>the method context</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>the error to send</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DBusGMethodInfo"></a><h3>struct DBusGMethodInfo</h3>
<pre class="programlisting">struct DBusGMethodInfo {
  GCallback                 function;    
  GClosureMarshal           marshaller;  
  int                       data_offset; 
};
</pre>
<p>Object typically generated by <a class="link" href="dbus-binding-tool.html" title="dbus-binding-tool"><span class="type">dbus-binding-tool</span></a> that
stores a mapping from introspection data to a
function pointer for a C method to be invoked.</p>
<div class="refsect3">
<a name="DBusGMethodInfo.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">GCallback</span> <em class="structfield"><code><a name="DBusGMethodInfo.function"></a>function</code></em>;</p></td>
<td class="struct_member_description"><p>C method to invoke</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">GClosureMarshal</span> <em class="structfield"><code><a name="DBusGMethodInfo.marshaller"></a>marshaller</code></em>;</p></td>
<td class="struct_member_description"><p>Marshaller to invoke method </p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">int</span> <em class="structfield"><code><a name="DBusGMethodInfo.data-offset"></a>data_offset</code></em>;</p></td>
<td class="struct_member_description"><p>Offset into the introspection data</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="DBusGMethodInvocation"></a><h3>DBusGMethodInvocation</h3>
<pre class="programlisting">typedef struct _DBusGMethodInvocation DBusGMethodInvocation;</pre>
<div class="warning">
<p><code class="literal">DBusGMethodInvocation</code> is deprecated and should not be used in newly-written code.</p>
<p>New code should use GDBus instead. The closest
 equivalent is <span class="type">GDBusMethodInvocation</span>.</p>
</div>
<p>The context of an asynchronous method call.  See <a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-return" title="dbus_g_method_return ()"><code class="function">dbus_g_method_return()</code></a> and
<a class="link" href="dbus-glib-DBusGMethod.html#dbus-g-method-return-error" title="dbus_g_method_return_error ()"><code class="function">dbus_g_method_return_error()</code></a>.</p>
</div>
</div>
<div class="refsect1">
<a name="dbus-glib-DBusGMethod.see-also"></a><h2>See Also</h2>
<p><a class="link" href="dbus-glib-DBusGMessage.html#DBusGMessage" title="DBusGMessage"><span class="type">DBusGMessage</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>