tizen 2.3.1 release
[external/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.75.2">
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.15.1 (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 <p>
53 </p>
54 </div>
55 <div class="refsect1">
56 <a name="gupnp-Error-codes.details"></a><h2>Details</h2>
57 <div class="refsect2">
58 <a name="GUPNP-SERVER-ERROR:CAPS"></a><h3>GUPNP_SERVER_ERROR</h3>
59 <pre class="programlisting">#define GUPNP_SERVER_ERROR (gupnp_server_error_quark ())
60 </pre>
61 <p>
62 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.
63 </p>
64 <p>
65 </p>
66 <div class="variablelist"><table border="0">
67 <col align="left" valign="top">
68 <tbody><tr>
69 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
70 <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.
71 </td>
72 </tr></tbody>
73 </table></div>
74 </div>
75 <hr>
76 <div class="refsect2">
77 <a name="GUPnPServerError"></a><h3>enum GUPnPServerError</h3>
78 <pre class="programlisting">typedef enum {
79         GUPNP_SERVER_ERROR_INTERNAL_SERVER_ERROR,
80         GUPNP_SERVER_ERROR_NOT_FOUND,
81         GUPNP_SERVER_ERROR_NOT_IMPLEMENTED,
82         GUPNP_SERVER_ERROR_INVALID_RESPONSE,
83         GUPNP_SERVER_ERROR_INVALID_URL,
84         GUPNP_SERVER_ERROR_OTHER
85 } GUPnPServerError;
86 </pre>
87 <p>
88 <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
89 is communication with another server.
90 </p>
91 <p>
92 </p>
93 <div class="variablelist"><table border="0">
94 <col align="left" valign="top">
95 <tbody>
96 <tr>
97 <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>
98 <td>Internal server error.
99 </td>
100 </tr>
101 <tr>
102 <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>
103 <td>The resource was not found.
104 </td>
105 </tr>
106 <tr>
107 <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>
108 <td>This method is not implemented.
109 </td>
110 </tr>
111 <tr>
112 <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>
113 <td>Invalid response.
114 </td>
115 </tr>
116 <tr>
117 <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>
118 <td>Invalid URL.
119 </td>
120 </tr>
121 <tr>
122 <td><p><a name="GUPNP-SERVER-ERROR-OTHER:CAPS"></a><span class="term"><code class="literal">GUPNP_SERVER_ERROR_OTHER</code></span></p></td>
123 <td>Unknown/unhandled error.
124 </td>
125 </tr>
126 </tbody>
127 </table></div>
128 </div>
129 <hr>
130 <div class="refsect2">
131 <a name="GUPNP-EVENTING-ERROR:CAPS"></a><h3>GUPNP_EVENTING_ERROR</h3>
132 <pre class="programlisting">#define GUPNP_EVENTING_ERROR (gupnp_eventing_error_quark ())
133 </pre>
134 <p>
135 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.
136 </p>
137 <p>
138 </p>
139 <div class="variablelist"><table border="0">
140 <col align="left" valign="top">
141 <tbody><tr>
142 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
143 <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.
144 </td>
145 </tr></tbody>
146 </table></div>
147 </div>
148 <hr>
149 <div class="refsect2">
150 <a name="GUPnPEventingError"></a><h3>enum GUPnPEventingError</h3>
151 <pre class="programlisting">typedef enum {
152         GUPNP_EVENTING_ERROR_SUBSCRIPTION_FAILED,
153         GUPNP_EVENTING_ERROR_SUBSCRIPTION_LOST,
154         GUPNP_EVENTING_ERROR_NOTIFY_FAILED
155 } GUPnPEventingError;
156 </pre>
157 <p>
158 <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
159 eventing of state variables.
160 </p>
161 <p>
162 </p>
163 <div class="variablelist"><table border="0">
164 <col align="left" valign="top">
165 <tbody>
166 <tr>
167 <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>
168 <td>The subscription attempt failed.
169 </td>
170 </tr>
171 <tr>
172 <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>
173 <td>The subscription was lost.
174 </td>
175 </tr>
176 <tr>
177 <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>
178 <td>The notification failed.
179 </td>
180 </tr>
181 </tbody>
182 </table></div>
183 </div>
184 <hr>
185 <div class="refsect2">
186 <a name="GUPNP-CONTROL-ERROR:CAPS"></a><h3>GUPNP_CONTROL_ERROR</h3>
187 <pre class="programlisting">#define GUPNP_CONTROL_ERROR (gupnp_control_error_quark ())
188 </pre>
189 <p>
190 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.
191 </p>
192 <p>
193 </p>
194 <div class="variablelist"><table border="0">
195 <col align="left" valign="top">
196 <tbody><tr>
197 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
198 <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.
199 </td>
200 </tr></tbody>
201 </table></div>
202 </div>
203 <hr>
204 <div class="refsect2">
205 <a name="GUPnPControlError"></a><h3>enum GUPnPControlError</h3>
206 <pre class="programlisting">typedef enum {
207         GUPNP_CONTROL_ERROR_INVALID_ACTION = 401,
208         GUPNP_CONTROL_ERROR_INVALID_ARGS   = 402,
209         GUPNP_CONTROL_ERROR_OUT_OF_SYNC    = 403,
210         GUPNP_CONTROL_ERROR_ACTION_FAILED  = 501
211 } GUPnPControlError;
212 </pre>
213 <p>
214 <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
215 invocation of service actions.
216 </p>
217 <p>
218 </p>
219 <div class="variablelist"><table border="0">
220 <col align="left" valign="top">
221 <tbody>
222 <tr>
223 <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>
224 <td>The action name was invalid.
225 </td>
226 </tr>
227 <tr>
228 <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>
229 <td>The action arguments were invalid.
230 </td>
231 </tr>
232 <tr>
233 <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>
234 <td>Out of sync (deprecated).
235 </td>
236 </tr>
237 <tr>
238 <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>
239 <td>The action failed.
240 </td>
241 </tr>
242 </tbody>
243 </table></div>
244 </div>
245 <hr>
246 <div class="refsect2">
247 <a name="GUPNP-XML-ERROR:CAPS"></a><h3>GUPNP_XML_ERROR</h3>
248 <pre class="programlisting">#define GUPNP_XML_ERROR (gupnp_xml_error_quark ())
249 </pre>
250 <p>
251 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.
252 </p>
253 <p>
254 </p>
255 <div class="variablelist"><table border="0">
256 <col align="left" valign="top">
257 <tbody><tr>
258 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
259 <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.
260 </td>
261 </tr></tbody>
262 </table></div>
263 </div>
264 <hr>
265 <div class="refsect2">
266 <a name="GUPnPXMLError"></a><h3>enum GUPnPXMLError</h3>
267 <pre class="programlisting">typedef enum {
268         GUPNP_XML_ERROR_PARSE,
269         GUPNP_XML_ERROR_NO_NODE,
270         GUPNP_XML_ERROR_EMPTY_NODE,
271         GUPNP_XML_ERROR_OTHER
272 } GUPnPXMLError;
273 </pre>
274 <p>
275 <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
276 processing of XML data.
277 </p>
278 <p>
279 </p>
280 <div class="variablelist"><table border="0">
281 <col align="left" valign="top">
282 <tbody>
283 <tr>
284 <td><p><a name="GUPNP-XML-ERROR-PARSE:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_PARSE</code></span></p></td>
285 <td>Generic XML parsing error.
286 </td>
287 </tr>
288 <tr>
289 <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>
290 <td>A required XML node was not found.
291 </td>
292 </tr>
293 <tr>
294 <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>
295 <td>An XML node is unexpectedly empty.
296 </td>
297 </tr>
298 <tr>
299 <td><p><a name="GUPNP-XML-ERROR-OTHER:CAPS"></a><span class="term"><code class="literal">GUPNP_XML_ERROR_OTHER</code></span></p></td>
300 <td>Unknown/unhandled XML related errors.
301 </td>
302 </tr>
303 </tbody>
304 </table></div>
305 </div>
306 </div>
307 </div>
308 <div class="footer">
309 <hr>
310           Generated by GTK-Doc V1.15.1</div>
311 </body>
312 </html>