Update gupnp to 0.20.5 (fdeb6f9f)
[profile/ivi/GUPnP.git] / doc / html / gupnp-Error-codes.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Error codes</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GUPnP Reference Manual">
8 <link rel="up" href="api-utility.html" title="Utility Functions">
9 <link rel="prev" href="GUPnPXMLDoc.html" title="GUPnPXMLDoc">
10 <link rel="next" href="gupnp-Special-UPnP-types.html" title="Special UPnP types">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="GUPnPXMLDoc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="api-utility.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GUPnP Reference Manual</th>
21 <td><a accesskey="n" href="gupnp-Special-UPnP-types.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gupnp-Error-codes.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gupnp-Error-codes.description" class="shortcut">Description</a>
27 </td></tr>
28 </table>
29 <div class="refentry">
30 <a name="gupnp-Error-codes"></a><div class="titlepage"></div>
31 <div class="refnamediv"><table width="100%"><tr>
32 <td valign="top">
33 <h2><span class="refentrytitle"><a name="gupnp-Error-codes.top_of_page"></a>Error codes</span></h2>
34 <p>Error codes — Error domains and codes.</p>
35 </td>
36 <td valign="top" align="right"></td>
37 </tr></table></div>
38 <div class="refsynopsisdiv">
39 <a name="gupnp-Error-codes.synopsis"></a><h2>Synopsis</h2>
40 <pre class="synopsis">#define             <a class="link" href="gupnp-Error-codes.html#GUPNP-SERVER-ERROR:CAPS" title="GUPNP_SERVER_ERROR">GUPNP_SERVER_ERROR</a>
41 enum                <a class="link" href="gupnp-Error-codes.html#GUPnPServerError" title="enum GUPnPServerError">GUPnPServerError</a>;
42 #define             <a class="link" href="gupnp-Error-codes.html#GUPNP-EVENTING-ERROR:CAPS" title="GUPNP_EVENTING_ERROR">GUPNP_EVENTING_ERROR</a>
43 enum                <a class="link" href="gupnp-Error-codes.html#GUPnPEventingError" title="enum GUPnPEventingError">GUPnPEventingError</a>;
44 #define             <a class="link" href="gupnp-Error-codes.html#GUPNP-CONTROL-ERROR:CAPS" title="GUPNP_CONTROL_ERROR">GUPNP_CONTROL_ERROR</a>
45 enum                <a class="link" href="gupnp-Error-codes.html#GUPnPControlError" title="enum GUPnPControlError">GUPnPControlError</a>;
46 #define             <a class="link" href="gupnp-Error-codes.html#GUPNP-XML-ERROR:CAPS" title="GUPNP_XML_ERROR">GUPNP_XML_ERROR</a>
47 enum                <a class="link" href="gupnp-Error-codes.html#GUPnPXMLError" title="enum GUPnPXMLError">GUPnPXMLError</a>;
48 </pre>
49 </div>
50 <div class="refsect1">
51 <a name="gupnp-Error-codes.description"></a><h2>Description</h2>
52 </div>
53 <div class="refsect1">
54 <a name="gupnp-Error-codes.details"></a><h2>Details</h2>
55 <div class="refsect2">
56 <a name="GUPNP-SERVER-ERROR:CAPS"></a><h3>GUPNP_SERVER_ERROR</h3>
57 <pre class="programlisting">#define GUPNP_SERVER_ERROR (gupnp_server_error_quark ())
58 </pre>
59 <p>
60 The <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP's server errors.
61 </p>
62 <div class="variablelist"><table border="0">
63 <col align="left" valign="top">
64 <tbody><tr>
65 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
66 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP's server errors.</td>
67 </tr></tbody>
68 </table></div>
69 </div>
70 <hr>
71 <div class="refsect2">
72 <a name="GUPnPServerError"></a><h3>enum GUPnPServerError</h3>
73 <pre class="programlisting">typedef enum {
74         GUPNP_SERVER_ERROR_INTERNAL_SERVER_ERROR,
75         GUPNP_SERVER_ERROR_NOT_FOUND,
76         GUPNP_SERVER_ERROR_NOT_IMPLEMENTED,
77         GUPNP_SERVER_ERROR_INVALID_RESPONSE,
78         GUPNP_SERVER_ERROR_INVALID_URL,
79         GUPNP_SERVER_ERROR_OTHER
80 } GUPnPServerError;
81 </pre>
82 <p>
83 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> codes used for errors in the <a class="link" href="gupnp-Error-codes.html#GUPNP-SERVER-ERROR:CAPS" title="GUPNP_SERVER_ERROR"><span class="type">GUPNP_SERVER_ERROR</span></a> domain, when there
84 is communication with another server.
85 </p>
86 <div class="variablelist"><table border="0">
87 <col align="left" valign="top">
88 <tbody>
89 <tr>
90 <td><p><a name="GUPNP-SERVER-ERROR-INTERNAL-SERVER-ERROR:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_INTERNAL_SERVER_ERROR</code></span></p></td>
91 <td>Internal server error.
92 </td>
93 </tr>
94 <tr>
95 <td><p><a name="GUPNP-SERVER-ERROR-NOT-FOUND:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_NOT_FOUND</code></span></p></td>
96 <td>The resource was not found.
97 </td>
98 </tr>
99 <tr>
100 <td><p><a name="GUPNP-SERVER-ERROR-NOT-IMPLEMENTED:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_NOT_IMPLEMENTED</code></span></p></td>
101 <td>This method is not implemented.
102 </td>
103 </tr>
104 <tr>
105 <td><p><a name="GUPNP-SERVER-ERROR-INVALID-RESPONSE:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_INVALID_RESPONSE</code></span></p></td>
106 <td>Invalid response.
107 </td>
108 </tr>
109 <tr>
110 <td><p><a name="GUPNP-SERVER-ERROR-INVALID-URL:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_INVALID_URL</code></span></p></td>
111 <td>Invalid URL.
112 </td>
113 </tr>
114 <tr>
115 <td><p><a name="GUPNP-SERVER-ERROR-OTHER:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_OTHER</code></span></p></td>
116 <td>Unknown/unhandled error.
117 </td>
118 </tr>
119 </tbody>
120 </table></div>
121 </div>
122 <hr>
123 <div class="refsect2">
124 <a name="GUPNP-EVENTING-ERROR:CAPS"></a><h3>GUPNP_EVENTING_ERROR</h3>
125 <pre class="programlisting">#define GUPNP_EVENTING_ERROR (gupnp_eventing_error_quark ())
126 </pre>
127 <p>
128 The <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP's eventing errors.
129 </p>
130 <div class="variablelist"><table border="0">
131 <col align="left" valign="top">
132 <tbody><tr>
133 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
134 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP's eventing errors.</td>
135 </tr></tbody>
136 </table></div>
137 </div>
138 <hr>
139 <div class="refsect2">
140 <a name="GUPnPEventingError"></a><h3>enum GUPnPEventingError</h3>
141 <pre class="programlisting">typedef enum {
142         GUPNP_EVENTING_ERROR_SUBSCRIPTION_FAILED,
143         GUPNP_EVENTING_ERROR_SUBSCRIPTION_LOST,
144         GUPNP_EVENTING_ERROR_NOTIFY_FAILED
145 } GUPnPEventingError;
146 </pre>
147 <p>
148 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> codes used for errors in the <a class="link" href="gupnp-Error-codes.html#GUPNP-EVENTING-ERROR:CAPS" title="GUPNP_EVENTING_ERROR"><span class="type">GUPNP_EVENTING_ERROR</span></a> domain, during
149 eventing of state variables.
150 </p>
151 <div class="variablelist"><table border="0">
152 <col align="left" valign="top">
153 <tbody>
154 <tr>
155 <td><p><a name="GUPNP-EVENTING-ERROR-SUBSCRIPTION-FAILED:CAPS"></a><span class="term"><code class="literal">GUPNP_EVENTING_ERROR_SUBSCRIPTION_FAILED</code></span></p></td>
156 <td>The subscription attempt failed.
157 </td>
158 </tr>
159 <tr>
160 <td><p><a name="GUPNP-EVENTING-ERROR-SUBSCRIPTION-LOST:CAPS"></a><span class="term"><code class="literal">GUPNP_EVENTING_ERROR_SUBSCRIPTION_LOST</code></span></p></td>
161 <td>The subscription was lost.
162 </td>
163 </tr>
164 <tr>
165 <td><p><a name="GUPNP-EVENTING-ERROR-NOTIFY-FAILED:CAPS"></a><span class="term"><code class="literal">GUPNP_EVENTING_ERROR_NOTIFY_FAILED</code></span></p></td>
166 <td>The notification failed.
167 </td>
168 </tr>
169 </tbody>
170 </table></div>
171 </div>
172 <hr>
173 <div class="refsect2">
174 <a name="GUPNP-CONTROL-ERROR:CAPS"></a><h3>GUPNP_CONTROL_ERROR</h3>
175 <pre class="programlisting">#define GUPNP_CONTROL_ERROR (gupnp_control_error_quark ())
176 </pre>
177 <p>
178 The <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP's control errors.
179 </p>
180 <div class="variablelist"><table border="0">
181 <col align="left" valign="top">
182 <tbody><tr>
183 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
184 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP's control errors.</td>
185 </tr></tbody>
186 </table></div>
187 </div>
188 <hr>
189 <div class="refsect2">
190 <a name="GUPnPControlError"></a><h3>enum GUPnPControlError</h3>
191 <pre class="programlisting">typedef enum {
192         GUPNP_CONTROL_ERROR_INVALID_ACTION = 401,
193         GUPNP_CONTROL_ERROR_INVALID_ARGS   = 402,
194         GUPNP_CONTROL_ERROR_OUT_OF_SYNC    = 403,
195         GUPNP_CONTROL_ERROR_ACTION_FAILED  = 501
196 } GUPnPControlError;
197 </pre>
198 <p>
199 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> codes used for errors in the <a class="link" href="gupnp-Error-codes.html#GUPNP-CONTROL-ERROR:CAPS" title="GUPNP_CONTROL_ERROR"><span class="type">GUPNP_CONTROL_ERROR</span></a> domain, during
200 invocation of service actions.
201 </p>
202 <div class="variablelist"><table border="0">
203 <col align="left" valign="top">
204 <tbody>
205 <tr>
206 <td><p><a name="GUPNP-CONTROL-ERROR-INVALID-ACTION:CAPS"></a><span class="term"><code class="literal">GUPNP_CONTROL_ERROR_INVALID_ACTION</code></span></p></td>
207 <td>The action name was invalid.
208 </td>
209 </tr>
210 <tr>
211 <td><p><a name="GUPNP-CONTROL-ERROR-INVALID-ARGS:CAPS"></a><span class="term"><code class="literal">GUPNP_CONTROL_ERROR_INVALID_ARGS</code></span></p></td>
212 <td>The action arguments were invalid.
213 </td>
214 </tr>
215 <tr>
216 <td><p><a name="GUPNP-CONTROL-ERROR-OUT-OF-SYNC:CAPS"></a><span class="term"><code class="literal">GUPNP_CONTROL_ERROR_OUT_OF_SYNC</code></span></p></td>
217 <td>Out of sync (deprecated).
218 </td>
219 </tr>
220 <tr>
221 <td><p><a name="GUPNP-CONTROL-ERROR-ACTION-FAILED:CAPS"></a><span class="term"><code class="literal">GUPNP_CONTROL_ERROR_ACTION_FAILED</code></span></p></td>
222 <td>The action failed.
223 </td>
224 </tr>
225 </tbody>
226 </table></div>
227 </div>
228 <hr>
229 <div class="refsect2">
230 <a name="GUPNP-XML-ERROR:CAPS"></a><h3>GUPNP_XML_ERROR</h3>
231 <pre class="programlisting">#define GUPNP_XML_ERROR (gupnp_xml_error_quark ())
232 </pre>
233 <p>
234 The <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP XML processing errors.
235 </p>
236 <div class="variablelist"><table border="0">
237 <col align="left" valign="top">
238 <tbody><tr>
239 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
240 <td>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> uniquely used by GUPnP XML processing errors.</td>
241 </tr></tbody>
242 </table></div>
243 </div>
244 <hr>
245 <div class="refsect2">
246 <a name="GUPnPXMLError"></a><h3>enum GUPnPXMLError</h3>
247 <pre class="programlisting">typedef enum {
248         GUPNP_XML_ERROR_PARSE,
249         GUPNP_XML_ERROR_NO_NODE,
250         GUPNP_XML_ERROR_EMPTY_NODE,
251         GUPNP_XML_ERROR_INVALID_ATTRIBUTE,
252         GUPNP_XML_ERROR_OTHER
253 } GUPnPXMLError;
254 </pre>
255 <p>
256 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> codes used for errors in the <a class="link" href="gupnp-Error-codes.html#GUPNP-XML-ERROR:CAPS" title="GUPNP_XML_ERROR"><span class="type">GUPNP_XML_ERROR</span></a> domain, during
257 processing of XML data.
258 </p>
259 <div class="variablelist"><table border="0">
260 <col align="left" valign="top">
261 <tbody>
262 <tr>
263 <td><p><a name="GUPNP-XML-ERROR-PARSE:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_PARSE</code></span></p></td>
264 <td>Generic XML parsing error.
265 </td>
266 </tr>
267 <tr>
268 <td><p><a name="GUPNP-XML-ERROR-NO-NODE:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_NO_NODE</code></span></p></td>
269 <td>A required XML node was not found.
270 </td>
271 </tr>
272 <tr>
273 <td><p><a name="GUPNP-XML-ERROR-EMPTY-NODE:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_EMPTY_NODE</code></span></p></td>
274 <td>An XML node is unexpectedly empty.
275 </td>
276 </tr>
277 <tr>
278 <td><p><a name="GUPNP-XML-ERROR-INVALID-ATTRIBUTE:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_INVALID_ATTRIBUTE</code></span></p></td>
279 <td>An XML node has an unknown attribute.
280 </td>
281 </tr>
282 <tr>
283 <td><p><a name="GUPNP-XML-ERROR-OTHER:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_OTHER</code></span></p></td>
284 <td>Unknown/unhandled XML related errors.
285 </td>
286 </tr>
287 </tbody>
288 </table></div>
289 </div>
290 </div>
291 </div>
292 <div class="footer">
293 <hr>
294           Generated by GTK-Doc V1.18</div>
295 </body>
296 </html>