ACC SHELL

Path : /usr/share/gtk-doc/html/polkit/
File Upload :
Current File : //usr/share/gtk-doc/html/polkit/polkit-Error-reporting.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Error reporting</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="PolicyKit Library Reference Manual">
<link rel="up" href="ref-core.html" title="Core API Reference">
<link rel="prev" href="polkit-Simple-convenience-interface.html" title="Simple convenience interface">
<link rel="next" href="polkit-Results.html" title="Results">
<meta name="generator" content="GTK-Doc V1.14 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="polkit-Simple-convenience-interface.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-core.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">PolicyKit Library Reference Manual</th>
<td><a accesskey="n" href="polkit-Results.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#polkit-Error-reporting.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#polkit-Error-reporting.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Error reporting">
<a name="polkit-Error-reporting"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="polkit-Error-reporting.top_of_page"></a>Error reporting</span></h2>
<p>Error reporting — Representation of recoverable errors.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="polkit-Error-reporting.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode">PolKitErrorCode</a>;
                    <a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError">PolKitError</a>;
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a>       <a class="link" href="polkit-Error-reporting.html#polkit-error-is-set" title="polkit_error_is_set ()">polkit_error_is_set</a>                 (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="polkit-Error-reporting.html#polkit-error-get-error-name" title="polkit_error_get_error_name ()">polkit_error_get_error_name</a>         (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);
<a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode"><span class="returnvalue">PolKitErrorCode</span></a>     <a class="link" href="polkit-Error-reporting.html#polkit-error-get-error-code" title="polkit_error_get_error_code ()">polkit_error_get_error_code</a>         (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="polkit-Error-reporting.html#polkit-error-get-error-message" title="polkit_error_get_error_message ()">polkit_error_get_error_message</a>      (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="polkit-Error-reporting.html#polkit-error-free" title="polkit_error_free ()">polkit_error_free</a>                   (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);
<a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a>       <a class="link" href="polkit-Error-reporting.html#polkit-error-set-error" title="polkit_error_set_error ()">polkit_error_set_error</a>              (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> **error</code></em>,
                                                         <em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode"><span class="type">PolKitErrorCode</span></a> error_code</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="polkit-Error-reporting.description"></a><h2>Description</h2>
<p>
Error codes from PolicyKit.
</p>
</div>
<div class="refsect1" title="Details">
<a name="polkit-Error-reporting.details"></a><h2>Details</h2>
<div class="refsect2" title="enum PolKitErrorCode">
<a name="PolKitErrorCode"></a><h3>enum PolKitErrorCode</h3>
<pre class="programlisting">typedef enum
{      
        POLKIT_ERROR_OUT_OF_MEMORY,
        POLKIT_ERROR_POLICY_FILE_INVALID,
        POLKIT_ERROR_GENERAL_ERROR,
        POLKIT_ERROR_NOT_AUTHORIZED_TO_READ_AUTHORIZATIONS_FOR_OTHER_USERS,
        POLKIT_ERROR_NOT_AUTHORIZED_TO_REVOKE_AUTHORIZATIONS_FROM_OTHER_USERS,
        POLKIT_ERROR_NOT_AUTHORIZED_TO_GRANT_AUTHORIZATION,
        POLKIT_ERROR_AUTHORIZATION_ALREADY_EXISTS,
        POLKIT_ERROR_NOT_SUPPORTED,
        POLKIT_ERROR_NOT_AUTHORIZED_TO_MODIFY_DEFAULTS,

        POLKIT_ERROR_NUM_ERROR_CODES
} PolKitErrorCode;
</pre>
<p>
Errors returned by PolicyKit
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="POLKIT-ERROR-OUT-OF-MEMORY:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_OUT_OF_MEMORY</code></span></p></td>
<td>Out of memory
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-POLICY-FILE-INVALID:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_POLICY_FILE_INVALID</code></span></p></td>
<td>There was an error parsing the given policy file
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-GENERAL-ERROR:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_GENERAL_ERROR</code></span></p></td>
<td>A general error code typically
indicating problems with the installation of PolicyKit,
e.g. helpers missing or wrong owner / permission.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-NOT-AUTHORIZED-TO-READ-AUTHORIZATIONS-FOR-OTHER-USERS:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_NOT_AUTHORIZED_TO_READ_AUTHORIZATIONS_FOR_OTHER_USERS</code></span></p></td>
<td>An attempt was made to read authorizations for other users and the
calling process is not authorized.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-NOT-AUTHORIZED-TO-REVOKE-AUTHORIZATIONS-FROM-OTHER-USERS:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_NOT_AUTHORIZED_TO_REVOKE_AUTHORIZATIONS_FROM_OTHER_USERS</code></span></p></td>
<td>An attempt was made to revoke authorizations for other users and the
calling process is not authorized.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-NOT-AUTHORIZED-TO-GRANT-AUTHORIZATION:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_NOT_AUTHORIZED_TO_GRANT_AUTHORIZATION</code></span></p></td>
<td>An attempt was
made to grant an authorization and the calling process is not
authorized.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-AUTHORIZATION-ALREADY-EXISTS:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_AUTHORIZATION_ALREADY_EXISTS</code></span></p></td>
<td>Subject already has an
similar authorization already (modulo time of grant and who granted).
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-NOT-SUPPORTED:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_NOT_SUPPORTED</code></span></p></td>
<td>The operation is not supported by the
authorization database backend
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-NOT-AUTHORIZED-TO-MODIFY-DEFAULTS:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_NOT_AUTHORIZED_TO_MODIFY_DEFAULTS</code></span></p></td>
<td>An attempt was
made to modify the defaults for implicit authorizations and the
calling process is not authorized.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-ERROR-NUM-ERROR-CODES:CAPS"></a><span class="term"><code class="literal">POLKIT_ERROR_NUM_ERROR_CODES</code></span></p></td>
<td>Number of error codes. This may change
from version to version; do not rely on it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="PolKitError">
<a name="PolKitError"></a><h3>PolKitError</h3>
<pre class="programlisting">typedef struct _PolKitError PolKitError;</pre>
<p>
Objects of this class are used for error reporting.
</p>
</div>
<hr>
<div class="refsect2" title="polkit_error_is_set ()">
<a name="polkit-error-is-set"></a><h3>polkit_error_is_set ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a>       polkit_error_is_set                 (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);</pre>
<p>
Determine if an error set
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>the error
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if, and only if, the error is set

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.7</p>
</div>
<hr>
<div class="refsect2" title="polkit_error_get_error_name ()">
<a name="polkit-error-get-error-name"></a><h3>polkit_error_get_error_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        polkit_error_get_error_name         (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);</pre>
<p>
Get the CamelCase name for the error;
e.g. <a class="link" href="polkit-Error-reporting.html#POLKIT-ERROR-OUT-OF-MEMORY:CAPS"><span class="type">POLKIT_ERROR_OUT_OF_MEMORY</span></a> maps to "OutOfMemory" and so on.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>the error
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the string

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.7</p>
</div>
<hr>
<div class="refsect2" title="polkit_error_get_error_code ()">
<a name="polkit-error-get-error-code"></a><h3>polkit_error_get_error_code ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode"><span class="returnvalue">PolKitErrorCode</span></a>     polkit_error_get_error_code         (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);</pre>
<p>
Returns the error code.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>the error object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A value from the <a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode"><span class="type">PolKitErrorCode</span></a> enumeration.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_error_get_error_message ()">
<a name="polkit-error-get-error-message"></a><h3>polkit_error_get_error_message ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        polkit_error_get_error_message      (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);</pre>
<p>
Get the error message.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>the error object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A string describing the error. Caller shall not free this string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_error_free ()">
<a name="polkit-error-free"></a><h3>polkit_error_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                polkit_error_free                   (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> *error</code></em>);</pre>
<p>
Free an error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>the error
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_error_set_error ()">
<a name="polkit-error-set-error"></a><h3>polkit_error_set_error ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="returnvalue">polkit_bool_t</span></a>       polkit_error_set_error              (<em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitError" title="PolKitError"><span class="type">PolKitError</span></a> **error</code></em>,
                                                         <em class="parameter"><code><a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode"><span class="type">PolKitErrorCode</span></a> error_code</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *format</code></em>,
                                                         <em class="parameter"><code>...</code></em>);</pre>
<p>
Sets an error. If OOM, the error will be set to a pre-allocated OOM error.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>the error object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_code</code></em> :</span></p></td>
<td>A value from the <a class="link" href="polkit-Error-reporting.html#PolKitErrorCode" title="enum PolKitErrorCode"><span class="type">PolKitErrorCode</span></a> enumeration.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>printf style formatting string
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>...</code></em> :</span></p></td>
<td>printf style arguments
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the error was set
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.14</div>
</body>
</html>

ACC SHELL 2018