docs/html/tlm-Errors.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>Tizen Login Manager Reference Manual: Errors</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="index.html" title="Tizen Login Manager Reference Manual">
   8 <link rel="up" href="ch03.html" title="Tlm miscellaneous">
   9 <link rel="prev" href="tlm-tlm-log.html" title="tlm-log">
  10 <link rel="next" href="object-tree.html" title="Object Hierarchy">
  11 <meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
  16 <td width="100%" align="left" class="shortcuts">
  17 <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
  18                   <a href="#tlm-Errors.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
  19                   <a href="#tlm-Errors.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
  20 </td>
  21 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  22 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  23 <td><a accesskey="p" href="tlm-tlm-log.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  24 <td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  25 </tr></table>
  26 <div class="refentry">
  27 <a name="tlm-Errors"></a><div class="titlepage"></div>
  28 <div class="refnamediv"><table width="100%"><tr>
  29 <td valign="top">
  30 <h2><span class="refentrytitle"><a name="tlm-Errors.top_of_page"></a>Errors</span></h2>
  31 <p>Errors — error definitions and utilities</p>
  32 </td>
  33 <td class="gallery_image" valign="top" align="right"></td>
  34 </tr></table></div>
  35 <div class="refsect1">
  36 <a name="tlm-Errors.functions"></a><h2>Functions</h2>
  37 <div class="informaltable"><table width="100%" border="0">
  38 <colgroup>
  39 <col width="150px" class="functions_return">
  40 <col class="functions_name">
  41 </colgroup>
  42 <tbody>
  43 <tr>
  44 <td class="define_keyword">#define</td>
  45 <td class="function_name"><a class="link" href="tlm-Errors.html#TLM-ERROR:CAPS" title="TLM_ERROR">TLM_ERROR</a></td>
  46 </tr>
  47 <tr>
  48 <td class="define_keyword">#define</td>
  49 <td class="function_name">
  50 <a class="link" href="tlm-Errors.html#TLM-GET-ERROR-FOR-ID:CAPS" title="TLM_GET_ERROR_FOR_ID()">TLM_GET_ERROR_FOR_ID</a><span class="c_punctuation">()</span>
  51 </td>
  52 </tr>
  53 <tr>
  54 <td class="function_type">
  55 <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
  56 </td>
  57 <td class="function_name">
  58 <a class="link" href="tlm-Errors.html#tlm-error-quark" title="tlm_error_quark ()">tlm_error_quark</a> <span class="c_punctuation">()</span>
  59 </td>
  60 </tr>
  61 <tr>
  62 <td class="function_type">
  63 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
  64 </td>
  65 <td class="function_name">
  66 <a class="link" href="tlm-Errors.html#tlm-error-new-from-variant" title="tlm_error_new_from_variant ()">tlm_error_new_from_variant</a> <span class="c_punctuation">()</span>
  67 </td>
  68 </tr>
  69 <tr>
  70 <td class="function_type">
  71 <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
  72 </td>
  73 <td class="function_name">
  74 <a class="link" href="tlm-Errors.html#tlm-error-to-variant" title="tlm_error_to_variant ()">tlm_error_to_variant</a> <span class="c_punctuation">()</span>
  75 </td>
  76 </tr>
  77 </tbody>
  78 </table></div>
  79 </div>
  80 <div class="refsect1">
  81 <a name="tlm-Errors.other"></a><h2>Types and Values</h2>
  82 <div class="informaltable"><table width="100%" border="0">
  83 <colgroup>
  84 <col width="150px" class="name">
  85 <col class="description">
  86 </colgroup>
  87 <tbody><tr>
  88 <td class="datatype_keyword">enum</td>
  89 <td class="function_name"><a class="link" href="tlm-Errors.html#TlmError" title="enum TlmError">TlmError</a></td>
  90 </tr></tbody>
  91 </table></div>
  92 </div>
  93 <div class="refsect1">
  94 <a name="tlm-Errors.object-hierarchy"></a><h2>Object Hierarchy</h2>
  95 <pre class="screen">
  96 </pre>
  97 </div>
  98 <div class="refsect1">
  99 <a name="tlm-Errors.description"></a><h2>Description</h2>
 100 <p>This file provides Tlm error definitions and utilities.
 101 When creating an error, use <a class="link" href="tlm-Errors.html#TLM-ERROR:CAPS" title="TLM_ERROR"><span class="type">TLM_ERROR</span></a> for the error domain and errors
 102 from <a class="link" href="tlm-Errors.html#TlmError" title="enum TlmError"><span class="type">TlmError</span></a> for the error code.</p>
 103 <div class="informalexample"><pre class="programlisting">
 104     GError* err = g_error_new(TLM_ERROR, TLM_ERROR_INVALID_INPUT,
 105     "Invalid input");
 106 </pre></div>
 107 <p></p>
 108 </div>
 109 <div class="refsect1">
 110 <a name="tlm-Errors.functions_details"></a><h2>Functions</h2>
 111 <div class="refsect2">
 112 <a name="TLM-ERROR:CAPS"></a><h3>TLM_ERROR</h3>
 113 <pre class="programlisting">#define TLM_ERROR   (tlm_error_quark())
 114 </pre>
 115 <p>This macro should be used when creating a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> (for example with
 116 <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#g-error-new"><code class="function">g_error_new()</code></a>).</p>
 117 </div>
 118 <hr>
 119 <div class="refsect2">
 120 <a name="TLM-GET-ERROR-FOR-ID:CAPS"></a><h3>TLM_GET_ERROR_FOR_ID()</h3>
 121 <pre class="programlisting">#define             TLM_GET_ERROR_FOR_ID(code, message, args...)</pre>
 122 <p>A helper macro that creates a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> with the proper tlm domain</p>
 123 <div class="refsect3">
 124 <a name="id-1.4.3.7.3.5"></a><h4>Parameters</h4>
 125 <div class="informaltable"><table width="100%" border="0">
 126 <colgroup>
 127 <col width="150px" class="parameters_name">
 128 <col class="parameters_description">
 129 <col width="200px" class="parameters_annotations">
 130 </colgroup>
 131 <tbody>
 132 <tr>
 133 <td class="parameter_name"><p>code</p></td>
 134 <td class="parameter_description"><p>A <a class="link" href="tlm-Errors.html#TlmError" title="enum TlmError"><span class="type">TlmError</span></a> specifying the error</p></td>
 135 <td class="parameter_annotations"> </td>
 136 </tr>
 137 <tr>
 138 <td class="parameter_name"><p>message</p></td>
 139 <td class="parameter_description"><p>Format string for the error message</p></td>
 140 <td class="parameter_annotations"> </td>
 141 </tr>
 142 <tr>
 143 <td class="parameter_name"><p>...</p></td>
 144 <td class="parameter_description"><p>parameters for the error string</p></td>
 145 <td class="parameter_annotations"> </td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 </div>
 150 </div>
 151 <hr>
 152 <div class="refsect2">
 153 <a name="tlm-error-quark"></a><h3>tlm_error_quark ()</h3>
 154 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
 155 tlm_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 156 <p>Creates and returns a domain for Tlm errors.</p>
 157 <div class="refsect3">
 158 <a name="id-1.4.3.7.4.5"></a><h4>Returns</h4>
 159 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> for Tlm errors</p>
 160 <p></p>
 161 </div>
 162 </div>
 163 <hr>
 164 <div class="refsect2">
 165 <a name="tlm-error-new-from-variant"></a><h3>tlm_error_new_from_variant ()</h3>
 166 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
 167 tlm_error_new_from_variant (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *var</code></em>);</pre>
 168 <p>Converts the GVariant to GError.</p>
 169 <div class="refsect3">
 170 <a name="id-1.4.3.7.5.5"></a><h4>Parameters</h4>
 171 <div class="informaltable"><table width="100%" border="0">
 172 <colgroup>
 173 <col width="150px" class="parameters_name">
 174 <col class="parameters_description">
 175 <col width="200px" class="parameters_annotations">
 176 </colgroup>
 177 <tbody><tr>
 178 <td class="parameter_name"><p>var</p></td>
 179 <td class="parameter_description"><p> instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a>. </p></td>
 180 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 181 </tr></tbody>
 182 </table></div>
 183 </div>
 184 <div class="refsect3">
 185 <a name="id-1.4.3.7.5.6"></a><h4>Returns</h4>
 186 <p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> object if successful, NULL otherwise. </p>
 187 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 188 </div>
 189 </div>
 190 <hr>
 191 <div class="refsect2">
 192 <a name="tlm-error-to-variant"></a><h3>tlm_error_to_variant ()</h3>
 193 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 194 tlm_error_to_variant (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *error</code></em>);</pre>
 195 <p>Converts the GError to GVariant.</p>
 196 <div class="refsect3">
 197 <a name="id-1.4.3.7.6.5"></a><h4>Parameters</h4>
 198 <div class="informaltable"><table width="100%" border="0">
 199 <colgroup>
 200 <col width="150px" class="parameters_name">
 201 <col class="parameters_description">
 202 <col width="200px" class="parameters_annotations">
 203 </colgroup>
 204 <tbody><tr>
 205 <td class="parameter_name"><p>error</p></td>
 206 <td class="parameter_description"><p> instance of <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>. </p></td>
 207 <td class="parameter_annotations"><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></td>
 208 </tr></tbody>
 209 </table></div>
 210 </div>
 211 <div class="refsect3">
 212 <a name="id-1.4.3.7.6.6"></a><h4>Returns</h4>
 213 <p> (transfer full) <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> object if successful, NULL otherwise.</p>
 214 <p></p>
 215 </div>
 216 </div>
 217 </div>
 218 <div class="refsect1">
 219 <a name="tlm-Errors.other_details"></a><h2>Types and Values</h2>
 220 <div class="refsect2">
 221 <a name="TlmError"></a><h3>enum TlmError</h3>
 222 <p>This enumeration provides a list of errors</p>
 223 <div class="refsect3">
 224 <a name="id-1.4.3.8.2.4"></a><h4>Members</h4>
 225 <div class="informaltable"><table width="100%" border="0">
 226 <colgroup>
 227 <col width="300px" class="enum_members_name">
 228 <col class="enum_members_description">
 229 <col width="200px" class="enum_members_annotations">
 230 </colgroup>
 231 <tbody>
 232 <tr>
 233 <td class="enum_member_name"><p><a name="TLM-ERROR-NONE:CAPS"></a>TLM_ERROR_NONE</p></td>
 234 <td class="enum_member_description">
 235 <p>No error</p>
 236 </td>
 237 <td class="enum_member_annotations"> </td>
 238 </tr>
 239 <tr>
 240 <td class="enum_member_name"><p><a name="TLM-ERROR-UNKNOWN:CAPS"></a>TLM_ERROR_UNKNOWN</p></td>
 241 <td class="enum_member_description">
 242 <p>Catch-all for errors not distinguished by another error
 243 code</p>
 244 </td>
 245 <td class="enum_member_annotations"> </td>
 246 </tr>
 247 <tr>
 248 <td class="enum_member_name"><p><a name="TLM-ERROR-INTERNAL-SERVER:CAPS"></a>TLM_ERROR_INTERNAL_SERVER</p></td>
 249 <td class="enum_member_description">
 250 <p>Server internal error</p>
 251 </td>
 252 <td class="enum_member_annotations"> </td>
 253 </tr>
 254 <tr>
 255 <td class="enum_member_name"><p><a name="TLM-ERROR-PERMISSION-DENIED:CAPS"></a>TLM_ERROR_PERMISSION_DENIED</p></td>
 256 <td class="enum_member_description">
 257 <p>Permission denied</p>
 258 </td>
 259 <td class="enum_member_annotations"> </td>
 260 </tr>
 261 <tr>
 262 <td class="enum_member_name"><p><a name="TLM-ERROR-INVALID-INPUT:CAPS"></a>TLM_ERROR_INVALID_INPUT</p></td>
 263 <td class="enum_member_description">
 264 <p>Invalid input</p>
 265 </td>
 266 <td class="enum_member_annotations"> </td>
 267 </tr>
 268 <tr>
 269 <td class="enum_member_name"><p><a name="TLM-ERROR-SEAT-NOT-FOUND:CAPS"></a>TLM_ERROR_SEAT_NOT_FOUND</p></td>
 270 <td class="enum_member_description">
 271 <p>Seat not found</p>
 272 </td>
 273 <td class="enum_member_annotations"> </td>
 274 </tr>
 275 <tr>
 276 <td class="enum_member_name"><p><a name="TLM-ERROR-SESSION-CREATION-FAILURE:CAPS"></a>TLM_ERROR_SESSION_CREATION_FAILURE</p></td>
 277 <td class="enum_member_description">
 278 <p>Session creation failed</p>
 279 </td>
 280 <td class="enum_member_annotations"> </td>
 281 </tr>
 282 <tr>
 283 <td class="enum_member_name"><p><a name="TLM-ERROR-SESSION-ALREADY-EXISTS:CAPS"></a>TLM_ERROR_SESSION_ALREADY_EXISTS</p></td>
 284 <td class="enum_member_description">
 285 <p>Session already exists</p>
 286 </td>
 287 <td class="enum_member_annotations"> </td>
 288 </tr>
 289 <tr>
 290 <td class="enum_member_name"><p><a name="TLM-ERROR-SESSION-NOT-VALID:CAPS"></a>TLM_ERROR_SESSION_NOT_VALID</p></td>
 291 <td class="enum_member_description">
 292 <p>session is not valid anymore</p>
 293 </td>
 294 <td class="enum_member_annotations"> </td>
 295 </tr>
 296 <tr>
 297 <td class="enum_member_name"><p><a name="TLM-ERROR-SESSION-TERMINATION-FAILURE:CAPS"></a>TLM_ERROR_SESSION_TERMINATION_FAILURE</p></td>
 298 <td class="enum_member_description">
 299 <p>Session termination failed</p>
 300 </td>
 301 <td class="enum_member_annotations"> </td>
 302 </tr>
 303 <tr>
 304 <td class="enum_member_name"><p><a name="TLM-ERROR-DBUS-SERVER-START-FAILURE:CAPS"></a>TLM_ERROR_DBUS_SERVER_START_FAILURE</p></td>
 305 <td class="enum_member_description">
 306 <p>dbus-server startup failed</p>
 307 </td>
 308 <td class="enum_member_annotations"> </td>
 309 </tr>
 310 <tr>
 311 <td class="enum_member_name"><p><a name="TLM-ERROR-PAM-AUTH-FAILURE:CAPS"></a>TLM_ERROR_PAM_AUTH_FAILURE</p></td>
 312 <td class="enum_member_description">
 313 <p>PAM authentication failed</p>
 314 </td>
 315 <td class="enum_member_annotations"> </td>
 316 </tr>
 317 <tr>
 318 <td class="enum_member_name"><p><a name="TLM-ERROR-DBUS-REQ-ABORTED:CAPS"></a>TLM_ERROR_DBUS_REQ_ABORTED</p></td>
 319 <td class="enum_member_description">
 320 <p>Dbus request aborted</p>
 321 </td>
 322 <td class="enum_member_annotations"> </td>
 323 </tr>
 324 <tr>
 325 <td class="enum_member_name"><p><a name="TLM-ERROR-DBUS-REQ-NOT-SUPPORTED:CAPS"></a>TLM_ERROR_DBUS_REQ_NOT_SUPPORTED</p></td>
 326 <td class="enum_member_description">
 327 <p>Dbus request not supported</p>
 328 </td>
 329 <td class="enum_member_annotations"> </td>
 330 </tr>
 331 <tr>
 332 <td class="enum_member_name"><p><a name="TLM-ERROR-DBUS-REQ-UNKNOWN:CAPS"></a>TLM_ERROR_DBUS_REQ_UNKNOWN</p></td>
 333 <td class="enum_member_description">
 334 <p>Dbus request failed with unknown error</p>
 335 </td>
 336 <td class="enum_member_annotations"> </td>
 337 </tr>
 338 <tr>
 339 <td class="enum_member_name"><p><a name="TLM-ERROR-LAST-ERR:CAPS"></a>TLM_ERROR_LAST_ERR</p></td>
 340 <td class="enum_member_description">
 341 <p>Placeholder to rearrange enumeration</p>
 342 </td>
 343 <td class="enum_member_annotations"> </td>
 344 </tr>
 345 </tbody>
 346 </table></div>
 347 </div>
 348 </div>
 349 </div>
 350 </div>
 351 <div class="footer">
 352 <hr>
 353           Generated by GTK-Doc V1.20</div>
 354 </body>
 355 </html>