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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="polkit-polkit-error">
<refmeta>
<refentrytitle role="top_of_page" id="polkit-polkit-error.top_of_page">Error reporting</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>POLKIT Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Error reporting</refname>
<refpurpose>Representation of recoverable errors.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="polkit-polkit-error.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
enum <link linkend="PolKitErrorCode">PolKitErrorCode</link>;
<link linkend="PolKitError">PolKitError</link>;
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-error-is-set">polkit_error_is_set</link> (<link linkend="PolKitError">PolKitError</link> *error);
const <link linkend="char">char</link>* <link linkend="polkit-error-get-error-name">polkit_error_get_error_name</link> (<link linkend="PolKitError">PolKitError</link> *error);
<link linkend="PolKitErrorCode">PolKitErrorCode</link> <link linkend="polkit-error-get-error-code">polkit_error_get_error_code</link> (<link linkend="PolKitError">PolKitError</link> *error);
const <link linkend="char">char</link>* <link linkend="polkit-error-get-error-message">polkit_error_get_error_message</link> (<link linkend="PolKitError">PolKitError</link> *error);
<link linkend="void">void</link> <link linkend="polkit-error-free">polkit_error_free</link> (<link linkend="PolKitError">PolKitError</link> *error);
<link linkend="polkit-bool-t">polkit_bool_t</link> <link linkend="polkit-error-set-error">polkit_error_set_error</link> (<link linkend="PolKitError">PolKitError</link> **error,
<link linkend="PolKitErrorCode">PolKitErrorCode</link> error_code,
const <link linkend="char">char</link> *format,
...);
</synopsis>
</refsynopsisdiv>
<refsect1 id="polkit-polkit-error.description" role="desc">
<title role="desc.title">Description</title>
<para>
Error codes from PolicyKit.</para>
<para>
</para>
</refsect1>
<refsect1 id="polkit-polkit-error.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PolKitErrorCode" role="enum">
<title>enum PolKitErrorCode</title>
<indexterm zone="PolKitErrorCode"><primary>PolKitErrorCode</primary></indexterm><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;
</programlisting>
<para>
Errors returned by PolicyKit</para>
<para>
</para><variablelist role="enum">
<varlistentry id="POLKIT-ERROR-OUT-OF-MEMORY:CAPS" role="constant">
<term><literal>POLKIT_ERROR_OUT_OF_MEMORY</literal></term>
<listitem><simpara> Out of memory
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-POLICY-FILE-INVALID:CAPS" role="constant">
<term><literal>POLKIT_ERROR_POLICY_FILE_INVALID</literal></term>
<listitem><simpara> There was an error parsing the given policy file
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-GENERAL-ERROR:CAPS" role="constant">
<term><literal>POLKIT_ERROR_GENERAL_ERROR</literal></term>
<listitem><simpara> A general error code typically
indicating problems with the installation of PolicyKit,
e.g. helpers missing or wrong owner / permission.
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-NOT-AUTHORIZED-TO-READ-AUTHORIZATIONS-FOR-OTHER-USERS:CAPS" role="constant">
<term><literal>POLKIT_ERROR_NOT_AUTHORIZED_TO_READ_AUTHORIZATIONS_FOR_OTHER_USERS</literal></term>
<listitem><simpara>
An attempt was made to read authorizations for other users and the
calling process is not authorized.
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-NOT-AUTHORIZED-TO-REVOKE-AUTHORIZATIONS-FROM-OTHER-USERS:CAPS" role="constant">
<term><literal>POLKIT_ERROR_NOT_AUTHORIZED_TO_REVOKE_AUTHORIZATIONS_FROM_OTHER_USERS</literal></term>
<listitem><simpara>
An attempt was made to revoke authorizations for other users and the
calling process is not authorized.
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-NOT-AUTHORIZED-TO-GRANT-AUTHORIZATION:CAPS" role="constant">
<term><literal>POLKIT_ERROR_NOT_AUTHORIZED_TO_GRANT_AUTHORIZATION</literal></term>
<listitem><simpara> An attempt was
made to grant an authorization and the calling process is not
authorized.
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-AUTHORIZATION-ALREADY-EXISTS:CAPS" role="constant">
<term><literal>POLKIT_ERROR_AUTHORIZATION_ALREADY_EXISTS</literal></term>
<listitem><simpara> Subject already has an
similar authorization already (modulo time of grant and who granted).
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-NOT-SUPPORTED:CAPS" role="constant">
<term><literal>POLKIT_ERROR_NOT_SUPPORTED</literal></term>
<listitem><simpara> The operation is not supported by the
authorization database backend
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-NOT-AUTHORIZED-TO-MODIFY-DEFAULTS:CAPS" role="constant">
<term><literal>POLKIT_ERROR_NOT_AUTHORIZED_TO_MODIFY_DEFAULTS</literal></term>
<listitem><simpara> An attempt was
made to modify the defaults for implicit authorizations and the
calling process is not authorized.
</simpara></listitem>
</varlistentry>
<varlistentry id="POLKIT-ERROR-NUM-ERROR-CODES:CAPS" role="constant">
<term><literal>POLKIT_ERROR_NUM_ERROR_CODES</literal></term>
<listitem><simpara> Number of error codes. This may change
from version to version; do not rely on it.
</simpara></listitem>
</varlistentry>
</variablelist></refsect2>
<refsect2 id="PolKitError" role="struct">
<title>PolKitError</title>
<indexterm zone="PolKitError"><primary>PolKitError</primary></indexterm><programlisting>typedef struct _PolKitError PolKitError;</programlisting>
<para>
Objects of this class are used for error reporting.</para>
<para>
</para></refsect2>
<refsect2 id="polkit-error-is-set" role="function" condition="since:0.7">
<title>polkit_error_is_set ()</title>
<indexterm zone="polkit-error-is-set" role="0.7"><primary>polkit_error_is_set</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_error_is_set (<link linkend="PolKitError">PolKitError</link> *error);</programlisting>
<para>
Determine if an error set</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><type>TRUE</type></link> if, and only if, the error is set
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.7
</para></refsect2>
<refsect2 id="polkit-error-get-error-name" role="function" condition="since:0.7">
<title>polkit_error_get_error_name ()</title>
<indexterm zone="polkit-error-get-error-name" role="0.7"><primary>polkit_error_get_error_name</primary></indexterm><programlisting>const <link linkend="char">char</link>* polkit_error_get_error_name (<link linkend="PolKitError">PolKitError</link> *error);</programlisting>
<para>
Get the CamelCase name for the error;
e.g. <link linkend="POLKIT-ERROR-OUT-OF-MEMORY:CAPS"><type>POLKIT_ERROR_OUT_OF_MEMORY</type></link> maps to "OutOfMemory" and so on.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the string
</simpara></listitem></varlistentry>
</variablelist><para role="since">Since 0.7
</para></refsect2>
<refsect2 id="polkit-error-get-error-code" role="function">
<title>polkit_error_get_error_code ()</title>
<indexterm zone="polkit-error-get-error-code"><primary>polkit_error_get_error_code</primary></indexterm><programlisting><link linkend="PolKitErrorCode">PolKitErrorCode</link> polkit_error_get_error_code (<link linkend="PolKitError">PolKitError</link> *error);</programlisting>
<para>
Returns the error code.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A value from the <link linkend="PolKitErrorCode"><type>PolKitErrorCode</type></link> enumeration.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-error-get-error-message" role="function">
<title>polkit_error_get_error_message ()</title>
<indexterm zone="polkit-error-get-error-message"><primary>polkit_error_get_error_message</primary></indexterm><programlisting>const <link linkend="char">char</link>* polkit_error_get_error_message (<link linkend="PolKitError">PolKitError</link> *error);</programlisting>
<para>
Get the error message.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error object
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A string describing the error. Caller shall not free this string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-error-free" role="function">
<title>polkit_error_free ()</title>
<indexterm zone="polkit-error-free"><primary>polkit_error_free</primary></indexterm><programlisting><link linkend="void">void</link> polkit_error_free (<link linkend="PolKitError">PolKitError</link> *error);</programlisting>
<para>
Free an error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="polkit-error-set-error" role="function">
<title>polkit_error_set_error ()</title>
<indexterm zone="polkit-error-set-error"><primary>polkit_error_set_error</primary></indexterm><programlisting><link linkend="polkit-bool-t">polkit_bool_t</link> polkit_error_set_error (<link linkend="PolKitError">PolKitError</link> **error,
<link linkend="PolKitErrorCode">PolKitErrorCode</link> error_code,
const <link linkend="char">char</link> *format,
...);</programlisting>
<para>
Sets an error. If OOM, the error will be set to a pre-allocated OOM error.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>error</parameter> :</term>
<listitem><simpara> the error object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error_code</parameter> :</term>
<listitem><simpara> A value from the <link linkend="PolKitErrorCode"><type>PolKitErrorCode</type></link> enumeration.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> printf style formatting string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> printf style arguments
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the error was set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
