← Back to branch summary

~peter-pearse/ubuntu/natty/dbus-glib/prop001

« back to all changes in this revision

Viewing changes to doc/reference/html/dbus-glib-DBusGError.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl
  • Date: 2008-06-06 00:05:01 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 lenny)
  • Revision ID: james.westby@ubuntu.com-20080606000501-948ly35rsovjfcg1
Tags: 0.76-1
* New upstream release.
* debian/patches/01-476080-freeze-error-abi.patch
  - Removed, merged upstream.
* debian/patches/02-ignore-namespaced-nodes-and-attributes.patch
  - Removed, merged upstream.
* Add symbols file for libdbus-glib-1-2. 
* debian/rules
  - Bump shlibs to >= 0.76 due to API additions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/dbus-glib-DBusGError.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
5
<title>DBusGError</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.71.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="D-Bus GLib bindings - Reference Manual">
8
8
<link rel="up" href="ch02.html" title="API Reference">
9
9
<link rel="prev" href="dbus-glib-DBusGMethod.html" title="DBusGMethod">
10
10
<link rel="next" href="dbus-glib-DBusGProxy.html" title="DBusGProxy">
11
 
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Introduction">
14
14
<link rel="chapter" href="ch02.html" title="API Reference">
23
23
<th width="100%" align="center">D-Bus GLib bindings - Reference Manual</th>
24
24
<td><a accesskey="n" href="dbus-glib-DBusGProxy.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
25
25
</tr>
26
 
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2587707" class="shortcut">Top</a>
 
26
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id341197" class="shortcut">Top</a>
27
27
                  &#160;|&#160;
28
 
                  <a href="#id2584779" class="shortcut">Description</a></nobr></td></tr>
 
28
                  <a href="#id344187" class="shortcut">Description</a></nobr></td></tr>
29
29
</table>
30
30
<div class="refentry" lang="en">
31
31
<a name="dbus-glib-DBusGError"></a><div class="titlepage"></div>
32
32
<div class="refnamediv"><table width="100%"><tr>
33
33
<td valign="top">
34
34
<h2>
35
 
<a name="id2587707"></a><span class="refentrytitle">DBusGError</span>
 
35
<a name="id341197"></a><span class="refentrytitle">DBusGError</span>
36
36
</h2>
37
37
<p>DBusGError &#8212; DBus GError</p>
38
38
</td>
39
39
<td valign="top" align="right"></td>
40
40
</tr></table></div>
41
41
<div class="refsect1" lang="en">
42
 
<a name="id2560467"></a><h2>Stability Level</h2>
 
42
<a name="id355912"></a><h2>Stability Level</h2>
43
43
Stable, unless otherwise indicated
44
44
</div>
45
45
<div class="refsynopsisdiv">
48
48
 
49
49
 
50
50
 
51
 
enum                <a href="dbus-glib-DBusGError.html#DBusGError">DBusGError</a>;
52
 
gboolean            <a href="dbus-glib-DBusGError.html#dbus-g-error-has-name">dbus_g_error_has_name</a>               (GError *error,
 
51
enum                <a class="link" href="dbus-glib-DBusGError.html#DBusGError">DBusGError</a>;
 
52
<a
 
53
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
54
>gboolean</a>            <a class="link" href="dbus-glib-DBusGError.html#dbus-g-error-has-name">dbus_g_error_has_name</a>               (<a
 
55
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
56
>GError</a> *error,
53
57
                                                         const char *name);
54
 
const char*         <a href="dbus-glib-DBusGError.html#dbus-g-error-get-name">dbus_g_error_get_name</a>               (GError *error);
55
 
GQuark              <a href="dbus-glib-DBusGError.html#dbus-g-error-quark">dbus_g_error_quark</a>                  (void);
56
 
void                <a href="dbus-glib-DBusGError.html#dbus-g-error-domain-register">dbus_g_error_domain_register</a>        (GQuark domain,
 
58
const char*         <a class="link" href="dbus-glib-DBusGError.html#dbus-g-error-get-name">dbus_g_error_get_name</a>               (<a
 
59
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
60
>GError</a> *error);
 
61
<a
 
62
href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"
 
63
>GQuark</a>              <a class="link" href="dbus-glib-DBusGError.html#dbus-g-error-quark">dbus_g_error_quark</a>                  (void);
 
64
void                <a class="link" href="dbus-glib-DBusGError.html#dbus-g-error-domain-register">dbus_g_error_domain_register</a>        (<a
 
65
href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"
 
66
>GQuark</a> domain,
57
67
                                                         const char *default_iface,
58
 
                                                         GType code_enum);
 
68
                                                         <a
 
69
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
 
70
>GType</a> code_enum);
59
71
 
60
72
</pre>
61
73
</div>
62
74
<div class="refsect1" lang="en">
63
 
<a name="id2584779"></a><h2>Description</h2>
 
75
<a name="id344187"></a><h2>Description</h2>
64
76
<p>
65
 
<a href="dbus-glib-DBusGError.html#DBusGError"><span class="type">DBusGError</span></a> is the <span class="type">GError</span> used by DBus.</p>
 
77
<a class="link" href="dbus-glib-DBusGError.html#DBusGError"><span class="type">DBusGError</span></a> is the <a
 
78
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
79
><span class="type">GError</span></a> used by DBus.</p>
66
80
<p>
67
81
 
68
82
</p>
69
83
</div>
70
84
<div class="refsect1" lang="en">
71
 
<a name="id2584813"></a><h2>Details</h2>
 
85
<a name="id330794"></a><h2>Details</h2>
72
86
<div class="refsect2" lang="en">
73
 
<a name="id2584824"></a><h3>
 
87
<a name="id330804"></a><h3>
74
88
<a name="DBusGError"></a>enum DBusGError</h3>
75
 
<a class="indexterm" name="id2584836"></a><pre class="programlisting">typedef enum
 
89
<a class="indexterm" name="id330816"></a><pre class="programlisting">typedef enum
76
90
{
77
 
#include "dbus-glib-error-enum.h" 
 
91
DBUS_GERROR_FAILED,
 
92
DBUS_GERROR_NO_MEMORY,
 
93
DBUS_GERROR_SERVICE_UNKNOWN,
 
94
DBUS_GERROR_NAME_HAS_NO_OWNER,
 
95
DBUS_GERROR_NO_REPLY,
 
96
DBUS_GERROR_IO_ERROR,
 
97
DBUS_GERROR_BAD_ADDRESS,
 
98
DBUS_GERROR_NOT_SUPPORTED,
 
99
DBUS_GERROR_LIMITS_EXCEEDED,
 
100
DBUS_GERROR_ACCESS_DENIED,
 
101
DBUS_GERROR_AUTH_FAILED,
 
102
DBUS_GERROR_NO_SERVER,
 
103
DBUS_GERROR_TIMEOUT,
 
104
DBUS_GERROR_NO_NETWORK,
 
105
DBUS_GERROR_ADDRESS_IN_USE,
 
106
DBUS_GERROR_DISCONNECTED,
 
107
DBUS_GERROR_INVALID_ARGS,
 
108
DBUS_GERROR_FILE_NOT_FOUND,
 
109
DBUS_GERROR_FILE_EXISTS,
 
110
DBUS_GERROR_UNKNOWN_METHOD,
 
111
DBUS_GERROR_TIMED_OUT,
 
112
DBUS_GERROR_MATCH_RULE_NOT_FOUND,
 
113
DBUS_GERROR_MATCH_RULE_INVALID,
 
114
DBUS_GERROR_SPAWN_EXEC_FAILED,
 
115
DBUS_GERROR_SPAWN_FORK_FAILED,
 
116
DBUS_GERROR_SPAWN_CHILD_EXITED,
 
117
DBUS_GERROR_SPAWN_CHILD_SIGNALED,
 
118
DBUS_GERROR_SPAWN_FAILED,
 
119
DBUS_GERROR_UNIX_PROCESS_ID_UNKNOWN,
 
120
DBUS_GERROR_INVALID_SIGNATURE,
 
121
DBUS_GERROR_INVALID_FILE_CONTENT,
 
122
DBUS_GERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN,
 
123
DBUS_GERROR_REMOTE_EXCEPTION
78
124
} DBusGError;
79
125
</pre>
80
126
<p>
83
129
</div>
84
130
<hr>
85
131
<div class="refsect2" lang="en">
86
 
<a name="id2562123"></a><h3>
 
132
<a name="id330840"></a><h3>
87
133
<a name="dbus-g-error-has-name"></a>dbus_g_error_has_name ()</h3>
88
 
<a class="indexterm" name="id2562134"></a><pre class="programlisting">gboolean            dbus_g_error_has_name               (GError *error,
 
134
<a class="indexterm" name="id330852"></a><pre class="programlisting"><a
 
135
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
 
136
>gboolean</a>            dbus_g_error_has_name               (<a
 
137
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
138
>GError</a> *error,
89
139
                                                         const char *name);</pre>
90
140
<p>
91
141
Determine whether D-BUS error name for a remote exception matches
102
152
<col align="left" valign="top">
103
153
<tbody>
104
154
<tr>
105
 
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
 
155
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
106
156
<td> the GError given from the remote method
107
157
</td>
108
158
</tr>
109
159
<tr>
110
 
<td><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></td>
 
160
<td><p><span class="term"><em class="parameter"><code>name</code></em>&#160;:</span></p></td>
111
161
<td> the D-BUS error name
112
162
</td>
113
163
</tr>
114
164
<tr>
115
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
165
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
116
166
<td> TRUE iff the remote error has the given name
117
167
</td>
118
168
</tr>
121
171
</div>
122
172
<hr>
123
173
<div class="refsect2" lang="en">
124
 
<a name="id2562222"></a><h3>
 
174
<a name="id329953"></a><h3>
125
175
<a name="dbus-g-error-get-name"></a>dbus_g_error_get_name ()</h3>
126
 
<a class="indexterm" name="id2562234"></a><pre class="programlisting">const char*         dbus_g_error_get_name               (GError *error);</pre>
 
176
<a class="indexterm" name="id329965"></a><pre class="programlisting">const char*         dbus_g_error_get_name               (<a
 
177
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
178
>GError</a> *error);</pre>
127
179
<p>
128
 
This function may only be invoked on a <span class="type">GError</span> returned from an
 
180
This function may only be invoked on a <a
 
181
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
182
><span class="type">GError</span></a> returned from an
129
183
invocation of a remote method, e.g. via dbus_g_proxy_end_call.
130
184
Moreover, you must ensure that the error's domain is <span class="type">DBUS_GERROR</span>,
131
185
and the code is <span class="type">DBUS_GERROR_REMOTE_EXCEPTION</span>.</p>
136
190
<col align="left" valign="top">
137
191
<tbody>
138
192
<tr>
139
 
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
140
 
<td> the <span class="type">GError</span> given from the remote method
 
193
<td><p><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></p></td>
 
194
<td> the <a
 
195
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
196
><span class="type">GError</span></a> given from the remote method
141
197
</td>
142
198
</tr>
143
199
<tr>
144
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
 
200
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
145
201
<td> the D-BUS name for a remote exception.
146
202
</td>
147
203
</tr>
150
206
</div>
151
207
<hr>
152
208
<div class="refsect2" lang="en">
153
 
<a name="id2561349"></a><h3>
 
209
<a name="id321315"></a><h3>
154
210
<a name="dbus-g-error-quark"></a>dbus_g_error_quark ()</h3>
155
 
<a class="indexterm" name="id2561361"></a><pre class="programlisting">GQuark              dbus_g_error_quark                  (void);</pre>
 
211
<a class="indexterm" name="id321327"></a><pre class="programlisting"><a
 
212
href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"
 
213
>GQuark</a>              dbus_g_error_quark                  (void);</pre>
156
214
<p>
157
215
The implementation of <span class="type">DBUS_GERROR</span> error domain. See documentation
158
 
for <span class="type">GError</span> in GLib reference manual.</p>
 
216
for <a
 
217
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
218
><span class="type">GError</span></a> in GLib reference manual.</p>
159
219
<p>
160
220
 
161
221
</p>
162
222
<div class="variablelist"><table border="0">
163
223
<col align="left" valign="top">
164
224
<tbody><tr>
165
 
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
166
 
<td> the error domain quark for use with <span class="type">GError</span>
 
225
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></p></td>
 
226
<td> the error domain quark for use with <a
 
227
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
228
><span class="type">GError</span></a>
167
229
</td>
168
230
</tr></tbody>
169
231
</table></div>
170
232
</div>
171
233
<hr>
172
234
<div class="refsect2" lang="en">
173
 
<a name="id2561421"></a><h3>
 
235
<a name="id321387"></a><h3>
174
236
<a name="dbus-g-error-domain-register"></a>dbus_g_error_domain_register ()</h3>
175
 
<a class="indexterm" name="id2561433"></a><pre class="programlisting">void                dbus_g_error_domain_register        (GQuark domain,
 
237
<a class="indexterm" name="id321400"></a><pre class="programlisting">void                dbus_g_error_domain_register        (<a
 
238
href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"
 
239
>GQuark</a> domain,
176
240
                                                         const char *default_iface,
177
 
                                                         GType code_enum);</pre>
 
241
                                                         <a
 
242
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
 
243
>GType</a> code_enum);</pre>
178
244
<p>
179
 
Register a <span class="type">GError</span> domain and set of codes with D-BUS.  You must
 
245
Register a <a
 
246
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
247
><span class="type">GError</span></a> domain and set of codes with D-BUS.  You must
180
248
have created a GEnum for the error codes.  This function will not
181
249
be needed with an introspection-capable GLib.</p>
182
250
<p>
186
254
<col align="left" valign="top">
187
255
<tbody>
188
256
<tr>
189
 
<td><span class="term"><em class="parameter"><code>domain</code></em>&#160;:</span></td>
190
 
<td> the <span class="type">GError</span> domain 
191
 
</td>
192
 
</tr>
193
 
<tr>
194
 
<td><span class="term"><em class="parameter"><code>default_iface</code></em>&#160;:</span></td>
195
 
<td> the D-BUS interface used for error values by default, or <span class="type">NULL</span>
196
 
</td>
197
 
</tr>
198
 
<tr>
199
 
<td><span class="term"><em class="parameter"><code>code_enum</code></em>&#160;:</span></td>
200
 
<td> a <span class="type">GType</span> for a <span class="type">GEnum</span> of the error codes
 
257
<td><p><span class="term"><em class="parameter"><code>domain</code></em>&#160;:</span></p></td>
 
258
<td> the <a
 
259
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
260
><span class="type">GError</span></a> domain 
 
261
</td>
 
262
</tr>
 
263
<tr>
 
264
<td><p><span class="term"><em class="parameter"><code>default_iface</code></em>&#160;:</span></p></td>
 
265
<td> the D-BUS interface used for error values by default, or <a
 
266
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
 
267
><span class="type">NULL</span></a>
 
268
</td>
 
269
</tr>
 
270
<tr>
 
271
<td><p><span class="term"><em class="parameter"><code>code_enum</code></em>&#160;:</span></p></td>
 
272
<td> a <a
 
273
href="/usr/share/gtk-doc/html/gobject/gobject-Type-Information.html#GType"
 
274
><span class="type">GType</span></a> for a <span class="type">GEnum</span> of the error codes
201
275
</td>
202
276
</tr>
203
277
</tbody>
205
279
</div>
206
280
</div>
207
281
<div class="refsect1" lang="en">
208
 
<a name="id2564732"></a><h2>See Also</h2>
209
 
<span class="type">GError</span>
 
282
<a name="id359090"></a><h2>See Also</h2>
 
283
<a
 
284
href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"
 
285
><span class="type">GError</span></a>
 
286
</div>
 
287
<div class="refsect1" lang="en">
 
288
<a name="id359102"></a><div class="refsect2" lang="en"><a name="id359104"></a></div>
 
289
<hr>
 
290
<div class="refsect2" lang="en"><a name="id359105"></a></div>
210
291
</div>
211
292
</div>
212
293
</body>