← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/dbus-glib/oneiric-updates

« back to all changes in this revision

Viewing changes to doc/reference/xml/dbus-gerror.xml

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2010-08-16 19:52:19 UTC
  • mfrom: (2.2.1 experimental) (2.1.9 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100816195219-ig40gau6zeskqey2
Tags: 0.88-2
Re-upload to unstable, with release team acknowledgement for squeeze

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/dbus-gerror.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY dbus-binding-tool SYSTEM "dbus-binding-tool.xml">
5
 
<!ENTITY version SYSTEM "version.xml">
6
 
]>
7
 
<refentry id="dbus-glib-DBusGError">
8
 
<refmeta>
9
 
<refentrytitle role="top_of_page" id="dbus-glib-DBusGError.top_of_page">DBusGError</refentrytitle>
10
 
<manvolnum>3</manvolnum>
11
 
<refmiscinfo>DBUS-GLIB Library</refmiscinfo>
12
 
</refmeta>
13
 
 
14
 
<refnamediv>
15
 
<refname>DBusGError</refname>
16
 
<refpurpose>DBus GError</refpurpose>
17
 
</refnamediv>
18
 
<refsect1 id="dbus-glib-DBusGError.stability-level">
19
 
<title>Stability Level</title>
20
 
Stable, unless otherwise indicated
21
 
</refsect1>
22
 
 
23
 
<refsynopsisdiv id="dbus-glib-DBusGError.synopsis" role="synopsis">
24
 
<title role="synopsis.title">Synopsis</title>
25
 
 
26
 
<synopsis>
27
 
enum                <link linkend="DBusGError">DBusGError</link>;
28
 
<link linkend="gboolean">gboolean</link>            <link linkend="dbus-g-error-has-name">dbus_g_error_has_name</link>               (<link linkend="GError">GError</link> *error,
29
 
                                                         const <link linkend="char">char</link> *name);
30
 
const <link linkend="char">char</link> *        <link linkend="dbus-g-error-get-name">dbus_g_error_get_name</link>               (<link linkend="GError">GError</link> *error);
31
 
<link linkend="GQuark">GQuark</link>              <link linkend="dbus-g-error-quark">dbus_g_error_quark</link>                  (void);
32
 
<link linkend="void">void</link>                <link linkend="dbus-g-error-domain-register">dbus_g_error_domain_register</link>        (<link linkend="GQuark">GQuark</link> domain,
33
 
                                                         const <link linkend="char">char</link> *default_iface,
34
 
                                                         <link linkend="GType">GType</link> code_enum);
35
 
</synopsis>
36
 
</refsynopsisdiv>
37
 
 
38
 
 
39
 
 
40
 
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
 
<refsect1 id="dbus-glib-DBusGError.description" role="desc">
47
 
<title role="desc.title">Description</title>
48
 
<para>
49
 
<link linkend="DBusGError"><type>DBusGError</type></link> is the <link linkend="GError"><type>GError</type></link> used by DBus.</para>
50
 
<para>
51
 
</para>
52
 
</refsect1>
53
 
 
54
 
<refsect1 id="dbus-glib-DBusGError.details" role="details">
55
 
<title role="details.title">Details</title>
56
 
<refsect2 id="DBusGError" role="enum">
57
 
<title>enum DBusGError</title>
58
 
<indexterm zone="DBusGError"><primary sortas="DBusGError">DBusGError</primary></indexterm><programlisting>typedef enum
59
 
{
60
 
DBUS_GERROR_FAILED,
61
 
DBUS_GERROR_NO_MEMORY,
62
 
DBUS_GERROR_SERVICE_UNKNOWN,
63
 
DBUS_GERROR_NAME_HAS_NO_OWNER,
64
 
DBUS_GERROR_NO_REPLY,
65
 
DBUS_GERROR_IO_ERROR,
66
 
DBUS_GERROR_BAD_ADDRESS,
67
 
DBUS_GERROR_NOT_SUPPORTED,
68
 
DBUS_GERROR_LIMITS_EXCEEDED,
69
 
DBUS_GERROR_ACCESS_DENIED,
70
 
DBUS_GERROR_AUTH_FAILED,
71
 
DBUS_GERROR_NO_SERVER,
72
 
DBUS_GERROR_TIMEOUT,
73
 
DBUS_GERROR_NO_NETWORK,
74
 
DBUS_GERROR_ADDRESS_IN_USE,
75
 
DBUS_GERROR_DISCONNECTED,
76
 
DBUS_GERROR_INVALID_ARGS,
77
 
DBUS_GERROR_FILE_NOT_FOUND,
78
 
DBUS_GERROR_FILE_EXISTS,
79
 
DBUS_GERROR_UNKNOWN_METHOD,
80
 
DBUS_GERROR_TIMED_OUT,
81
 
DBUS_GERROR_MATCH_RULE_NOT_FOUND,
82
 
DBUS_GERROR_MATCH_RULE_INVALID,
83
 
DBUS_GERROR_SPAWN_EXEC_FAILED,
84
 
DBUS_GERROR_SPAWN_FORK_FAILED,
85
 
DBUS_GERROR_SPAWN_CHILD_EXITED,
86
 
DBUS_GERROR_SPAWN_CHILD_SIGNALED,
87
 
DBUS_GERROR_SPAWN_FAILED,
88
 
DBUS_GERROR_UNIX_PROCESS_ID_UNKNOWN,
89
 
DBUS_GERROR_INVALID_SIGNATURE,
90
 
DBUS_GERROR_INVALID_FILE_CONTENT,
91
 
DBUS_GERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN,
92
 
DBUS_GERROR_REMOTE_EXCEPTION
93
 
} DBusGError;
94
 
</programlisting>
95
 
<para>
96
 
</para></refsect2>
97
 
<refsect2 id="dbus-g-error-has-name" role="function">
98
 
<title>dbus_g_error_has_name ()</title>
99
 
<indexterm zone="dbus-g-error-has-name"><primary sortas="dbus_g_error_has_name">dbus_g_error_has_name</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            dbus_g_error_has_name               (<link linkend="GError">GError</link> *error,
100
 
                                                         const <link linkend="char">char</link> *name);</programlisting>
101
 
<para>
102
 
Determine whether D-BUS error name for a remote exception matches
103
 
the given name.  This function is intended to be invoked on a
104
 
GError returned from an invocation of a remote method, e.g. via
105
 
dbus_g_proxy_end_call.  It will silently return FALSE for errors
106
 
which are not remote D-BUS exceptions (i.e. with a domain other
107
 
than DBUS_GERROR or a code other than
108
 
DBUS_GERROR_REMOTE_EXCEPTION).</para>
109
 
<para>
110
 
</para><variablelist role="params">
111
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
112
 
<listitem><simpara> the GError given from the remote method
113
 
</simpara></listitem></varlistentry>
114
 
<varlistentry><term><parameter>name</parameter>&#160;:</term>
115
 
<listitem><simpara> the D-BUS error name
116
 
</simpara></listitem></varlistentry>
117
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE iff the remote error has the given name
118
 
</simpara></listitem></varlistentry>
119
 
</variablelist></refsect2>
120
 
<refsect2 id="dbus-g-error-get-name" role="function">
121
 
<title>dbus_g_error_get_name ()</title>
122
 
<indexterm zone="dbus-g-error-get-name"><primary sortas="dbus_g_error_get_name">dbus_g_error_get_name</primary></indexterm><programlisting>const <link linkend="char">char</link> *        dbus_g_error_get_name               (<link linkend="GError">GError</link> *error);</programlisting>
123
 
<para>
124
 
This function may only be invoked on a <link linkend="GError"><type>GError</type></link> returned from an
125
 
invocation of a remote method, e.g. via dbus_g_proxy_end_call.
126
 
Moreover, you must ensure that the error's domain is <link linkend="DBUS-GERROR--CAPS"><type>DBUS_GERROR</type></link>,
127
 
and the code is <link linkend="DBUS-GERROR-REMOTE-EXCEPTION--CAPS"><type>DBUS_GERROR_REMOTE_EXCEPTION</type></link>.</para>
128
 
<para>
129
 
</para><variablelist role="params">
130
 
<varlistentry><term><parameter>error</parameter>&#160;:</term>
131
 
<listitem><simpara> the <link linkend="GError"><type>GError</type></link> given from the remote method
132
 
</simpara></listitem></varlistentry>
133
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the D-BUS name for a remote exception.
134
 
</simpara></listitem></varlistentry>
135
 
</variablelist></refsect2>
136
 
<refsect2 id="dbus-g-error-quark" role="function">
137
 
<title>dbus_g_error_quark ()</title>
138
 
<indexterm zone="dbus-g-error-quark"><primary sortas="dbus_g_error_quark">dbus_g_error_quark</primary></indexterm><programlisting><link linkend="GQuark">GQuark</link>              dbus_g_error_quark                  (void);</programlisting>
139
 
<para>
140
 
The implementation of <link linkend="DBUS-GERROR--CAPS"><type>DBUS_GERROR</type></link> error domain. See documentation
141
 
for <link linkend="GError"><type>GError</type></link> in GLib reference manual.</para>
142
 
<para>
143
 
</para><variablelist role="params">
144
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the error domain quark for use with <link linkend="GError"><type>GError</type></link>
145
 
</simpara></listitem></varlistentry>
146
 
</variablelist></refsect2>
147
 
<refsect2 id="dbus-g-error-domain-register" role="function">
148
 
<title>dbus_g_error_domain_register ()</title>
149
 
<indexterm zone="dbus-g-error-domain-register"><primary sortas="dbus_g_error_domain_register">dbus_g_error_domain_register</primary></indexterm><programlisting><link linkend="void">void</link>                dbus_g_error_domain_register        (<link linkend="GQuark">GQuark</link> domain,
150
 
                                                         const <link linkend="char">char</link> *default_iface,
151
 
                                                         <link linkend="GType">GType</link> code_enum);</programlisting>
152
 
<para>
153
 
Register a <link linkend="GError"><type>GError</type></link> domain and set of codes with D-BUS.  You must
154
 
have created a GEnum for the error codes.  This function will not
155
 
be needed with an introspection-capable GLib.</para>
156
 
<para>
157
 
</para><variablelist role="params">
158
 
<varlistentry><term><parameter>domain</parameter>&#160;:</term>
159
 
<listitem><simpara> the <link linkend="GError"><type>GError</type></link> domain 
160
 
</simpara></listitem></varlistentry>
161
 
<varlistentry><term><parameter>default_iface</parameter>&#160;:</term>
162
 
<listitem><simpara> the D-BUS interface used for error values by default, or <link linkend="NULL--CAPS"><type>NULL</type></link>
163
 
</simpara></listitem></varlistentry>
164
 
<varlistentry><term><parameter>code_enum</parameter>&#160;:</term>
165
 
<listitem><simpara> a <link linkend="GType"><type>GType</type></link> for a <link linkend="GEnum"><type>GEnum</type></link> of the error codes
166
 
</simpara></listitem></varlistentry>
167
 
</variablelist></refsect2>
168
 
 
169
 
</refsect1>
170
 
 
171
 
 
172
 
 
173
 
<refsect1 id="dbus-glib-DBusGError.see-also">
174
 
<title>See Also</title>
175
 
#GError
176
 
</refsect1>
177
 
 
178
 
</refentry>