/usr/share/gtk-doc/html/gconf/gconf-gconf-error.html is in libgconf2-doc 3.2.6-3ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GError: GConf Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GConf Reference Manual">
<link rel="up" href="ch01.html" title="Using the GConf library">
<link rel="prev" href="gconf-gconf-engine.html" title="GConfEngine">
<link rel="next" href="gconf-gconf-internals.html" title="gconf-internals">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#gconf-gconf-error.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gconf-gconf-engine.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gconf-gconf-internals.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gconf-gconf-error"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gconf-gconf-error.top_of_page"></a>GError</span></h2>
<p>GError — error reporting.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gconf-gconf-error.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-error.html#gconf-error-new" title="gconf_error_new ()">gconf_error_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-error.html#gconf-error-quark" title="gconf_error_quark ()">gconf_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-error.html#gconf-set-error" title="gconf_set_error ()">gconf_set_error</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
</td>
<td class="function_name">
<a class="link" href="gconf-gconf-error.html#gconf-compose-errors" title="gconf_compose_errors ()">gconf_compose_errors</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gconf-gconf-error.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="gconf-gconf-error.html#GConfError" title="enum GConfError">GConfError</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gconf-gconf-error.description"></a><h2>Description</h2>
<p>
The <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> object is used to report errors that occur in GConf
library routines. All functions that report errors work the same way:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
The last argument to the function is a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>**, a pointer to a
location where a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>* can be placed.
</p></li>
<li class="listitem"><p>
This last argument may be <span class="symbol">NULL</span>, in which case no
error will be returned.
</p></li>
<li class="listitem"><p>
If non-<span class="symbol">NULL</span>, the argument should be the address of a
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>* variable, which should be initialized to
<span class="symbol">NULL</span>.
</p></li>
<li class="listitem"><p>
If an error occurs, a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> will be allocated and placed in the
return location; the caller must free the <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> with
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free"><code class="function">g_error_free()</code></a>. If no error occurs, the return location will be
left untouched. That is, the test <code class="literal">error != NULL</code>
should always be a reliable indicator of whether the operation failed.
</p></li>
</ul></div>
<p>
</p>
<p>
It's also common that the return value of a function indicates whether
or not an error occurred. Typically, <span class="symbol">TRUE</span> is returned
on success. In some cases, a <span class="symbol">NULL</span> return value
indicates failure. Either way, if the return value indicates failure
and you passed a non-<span class="symbol">NULL</span> value for the last argument
to the function, a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> will be returned. If the return value
indicates success, then a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> will never be returned. These
relationships are guaranteed; that is, you can reliably use the return
value to decide whether a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> was placed in the return
location. If a function does <span class="emphasis"><em>not</em></span> indicate
success/failure by return value, you must check whether the
<a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> is <span class="symbol">NULL</span> to detect errors.
</p>
<p>
Here's a short error handling example:
</p>
<pre class="programlisting">
GError* err = NULL;
if (!gconf_init(&err))
{
fprintf(stderr, _("Failed to init GConf: %s\n"), err->message);
g_error_free(err);
err = NULL;
}
</pre>
<p>
</p>
</div>
<div class="refsect1">
<a name="gconf-gconf-error.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gconf-error-new"></a><h3>gconf_error_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
gconf_error_new (<em class="parameter"><code><a class="link" href="gconf-gconf-error.html#GConfError" title="enum GConfError"><span class="type">GConfError</span></a> en</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Creates a new error. Normally the GConf library does this, but you
might find a reason to do it as well. <em class="parameter"><code>en</code></em> is the error number, <em class="parameter"><code>format</code></em>
is a <code class="function">printf()</code>-style format for the error message, and the variable
argument list is the same as in <code class="function">printf()</code>.
</p>
<div class="refsect3">
<a name="id-1.2.5.6.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>en</p></td>
<td class="parameter_description"><p>the error number.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>printf()-style format for error description.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.6.2.6"></a><h4>Returns</h4>
<p>newly-allocated <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gconf-error-quark"></a><h3>gconf_error_quark ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="returnvalue">GQuark</span></a>
gconf_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Converts the string 'gconf-error-quark' to a <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> and returns the value.
</p>
<div class="refsect3">
<a name="id-1.2.5.6.3.5"></a><h4>Returns</h4>
<p>the <a href="/usr/share/gtk-doc/html/glib/glib-Quarks.html#GQuark"><span class="type">GQuark</span></a> representing the string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gconf-set-error"></a><h3>gconf_set_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gconf_set_error (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>,
<em class="parameter"><code><a class="link" href="gconf-gconf-error.html#GConfError" title="enum GConfError"><span class="type">GConfError</span></a> en</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
<em class="parameter"><code>...</code></em>);</pre>
<p>
Internal function.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gconf-compose-errors"></a><h3>gconf_compose_errors ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="returnvalue">GError</span></a> *
gconf_compose_errors (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *err1</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> *err2</code></em>);</pre>
<p>
Internal function.
</p>
</div>
</div>
<div class="refsect1">
<a name="gconf-gconf-error.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GConfError"></a><h3>enum GConfError</h3>
<p>
The <a class="link" href="gconf-gconf-error.html#GConfError" title="enum GConfError"><span class="type">GConfError</span></a> enumeration allows client applications to
differentiate between different kinds of error. You may wish to take
specific actions depending on the error type.
</p>
<div class="refsect3">
<a name="id-1.2.5.7.2.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-SUCCESS:CAPS"></a>GCONF_ERROR_SUCCESS</p></td>
<td class="enum_member_description">
<p>indicates that no error occurred, won't be returned in a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-FAILED:CAPS"></a>GCONF_ERROR_FAILED</p></td>
<td class="enum_member_description">
<p>indicates failure, but no more specific <a class="link" href="gconf-gconf-error.html#GConfError" title="enum GConfError"><span class="type">GConfError</span></a> applied.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-NO-SERVER:CAPS"></a>GCONF_ERROR_NO_SERVER</p></td>
<td class="enum_member_description">
<p>indicates that the GConf server couldn't be contacted, probably a CORBA problem.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-NO-PERMISSION:CAPS"></a>GCONF_ERROR_NO_PERMISSION</p></td>
<td class="enum_member_description">
<p>indicates that permission to access some resource was denied.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-BAD-ADDRESS:CAPS"></a>GCONF_ERROR_BAD_ADDRESS</p></td>
<td class="enum_member_description">
<p>indicates that a configuration source address was syntactically invalid or impossible to resolve.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-BAD-KEY:CAPS"></a>GCONF_ERROR_BAD_KEY</p></td>
<td class="enum_member_description">
<p>indicates that a key was malformed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-PARSE-ERROR:CAPS"></a>GCONF_ERROR_PARSE_ERROR</p></td>
<td class="enum_member_description">
<p>indicates that some parsing was done (perhaps in a backend) and it failed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-CORRUPT:CAPS"></a>GCONF_ERROR_CORRUPT</p></td>
<td class="enum_member_description">
<p>indicates that some part of the database is corrupt.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-TYPE-MISMATCH:CAPS"></a>GCONF_ERROR_TYPE_MISMATCH</p></td>
<td class="enum_member_description">
<p>indicates that a specific type was required, and another type was found.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-IS-DIR:CAPS"></a>GCONF_ERROR_IS_DIR</p></td>
<td class="enum_member_description">
<p>indicates that an operation only applicable to keys was performed on a directory.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-IS-KEY:CAPS"></a>GCONF_ERROR_IS_KEY</p></td>
<td class="enum_member_description">
<p>indicates that an operation only applicable to directories was performed on a key.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-OVERRIDDEN:CAPS"></a>GCONF_ERROR_OVERRIDDEN</p></td>
<td class="enum_member_description">
<p>indicates that the administrator has imposed a mandatory value, and it could not be changed.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-OAF-ERROR:CAPS"></a>GCONF_ERROR_OAF_ERROR</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-LOCAL-ENGINE:CAPS"></a>GCONF_ERROR_LOCAL_ENGINE</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-LOCK-FAILED:CAPS"></a>GCONF_ERROR_LOCK_FAILED</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-NO-WRITABLE-DATABASE:CAPS"></a>GCONF_ERROR_NO_WRITABLE_DATABASE</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GCONF-ERROR-IN-SHUTDOWN:CAPS"></a>GCONF_ERROR_IN_SHUTDOWN</p></td>
<td class="enum_member_description"> </td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|