ACC SHELL
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Policy Cache</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-Defaults.html" title="Defaults">
<link rel="next" href="polkit-Authorization-Entry.html" title="Authorization Entry">
<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-Defaults.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-Authorization-Entry.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-Policy-Cache.synopsis" class="shortcut">Top</a>
|
<a href="#polkit-Policy-Cache.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Policy Cache">
<a name="polkit-Policy-Cache"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="polkit-Policy-Cache.top_of_page"></a>Policy Cache</span></h2>
<p>Policy Cache — Holds the actions defined on the system.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="polkit-Policy-Cache.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache">PolKitPolicyCache</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-Policy-Cache.html#PolKitPolicyCacheForeachFunc" title="PolKitPolicyCacheForeachFunc ()">*PolKitPolicyCacheForeachFunc</a>) (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="returnvalue">PolKitPolicyCache</span></a> * <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-ref" title="polkit_policy_cache_ref ()">polkit_policy_cache_ref</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>);
<span class="returnvalue">void</span> <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-unref" title="polkit_policy_cache_unref ()">polkit_policy_cache_unref</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>);
<span class="returnvalue">void</span> <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-debug" title="polkit_policy_cache_debug ()">polkit_policy_cache_debug</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>);
<a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="returnvalue">PolKitPolicyFileEntry</span></a>* <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-get-entry" title="polkit_policy_cache_get_entry ()">polkit_policy_cache_get_entry</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);
<a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="returnvalue">PolKitPolicyFileEntry</span></a>* <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-get-entry-by-id" title="polkit_policy_cache_get_entry_by_id ()">polkit_policy_cache_get_entry_by_id</a>
(<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *action_id</code></em>);
<a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="returnvalue">PolKitPolicyFileEntry</span></a>* <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-get-entry-by-annotation" title="polkit_policy_cache_get_entry_by_annotation ()">polkit_policy_cache_get_entry_by_annotation</a>
(<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *annotation_key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *annotation_value</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-Policy-Cache.html#polkit-policy-cache-foreach" title="polkit_policy_cache_foreach ()">polkit_policy_cache_foreach</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCacheForeachFunc" title="PolKitPolicyCacheForeachFunc ()"><span class="type">PolKitPolicyCacheForeachFunc</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="polkit-Policy-Cache.description"></a><h2>Description</h2>
<p>
This class is used to hold all policy objects (stemming from policy
files) and provide look-up functions.
</p>
</div>
<div class="refsect1" title="Details">
<a name="polkit-Policy-Cache.details"></a><h2>Details</h2>
<div class="refsect2" title="PolKitPolicyCache">
<a name="PolKitPolicyCache"></a><h3>PolKitPolicyCache</h3>
<pre class="programlisting">typedef struct _PolKitPolicyCache PolKitPolicyCache;</pre>
<p>
Instances of this class are used to hold all policy objects
(stemming from policy files) and provide look-up functions.
</p>
</div>
<hr>
<div class="refsect2" title="PolKitPolicyCacheForeachFunc ()">
<a name="PolKitPolicyCacheForeachFunc"></a><h3>PolKitPolicyCacheForeachFunc ()</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> (*PolKitPolicyCacheForeachFunc) (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Callback function for <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-foreach" title="polkit_policy_cache_foreach ()"><code class="function">polkit_policy_cache_foreach()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the policy cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
<td>an entry in the cache - do not unref
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data passed to <a class="link" href="polkit-Policy-Cache.html#polkit-policy-cache-foreach" title="polkit_policy_cache_foreach ()"><code class="function">polkit_policy_cache_foreach()</code></a>
</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> to short-circuit; e.g. stop the iteration
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_ref ()">
<a name="polkit-policy-cache-ref"></a><h3>polkit_policy_cache_ref ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="returnvalue">PolKitPolicyCache</span></a> * polkit_policy_cache_ref (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>);</pre>
<p>
Increase reference count.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the policy cache object
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_unref ()">
<a name="polkit-policy-cache-unref"></a><h3>polkit_policy_cache_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> polkit_policy_cache_unref (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>);</pre>
<p>
Decreases the reference count of the object. If it becomes zero,
the object is freed. Before freeing, reference counts on embedded
objects are decresed by one.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the policy cache object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_debug ()">
<a name="polkit-policy-cache-debug"></a><h3>polkit_policy_cache_debug ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> polkit_policy_cache_debug (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>);</pre>
<p>
Print debug information about object
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the cache
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_get_entry ()">
<a name="polkit-policy-cache-get-entry"></a><h3>polkit_policy_cache_get_entry ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="returnvalue">PolKitPolicyFileEntry</span></a>* polkit_policy_cache_get_entry (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Actions.html#PolKitAction" title="PolKitAction"><span class="type">PolKitAction</span></a> *action</code></em>);</pre>
<p>
Given a action, find the object describing the definition of the
policy; e.g. data stemming from files in
/usr/share/PolicyKit/policy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em> :</span></p></td>
<td>the action
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> entry on sucess; otherwise
<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if the action wasn't identified. Caller shall not unref
this object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_get_entry_by_id ()">
<a name="polkit-policy-cache-get-entry-by-id"></a><h3>polkit_policy_cache_get_entry_by_id ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="returnvalue">PolKitPolicyFileEntry</span></a>* polkit_policy_cache_get_entry_by_id
(<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *action_id</code></em>);</pre>
<p>
Given a action identifier, find the object describing the
definition of the policy; e.g. data stemming from files in
/usr/share/PolicyKit/policy.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_id</code></em> :</span></p></td>
<td>the action identifier
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> entry on sucess; otherwise
<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if the action wasn't identified. Caller shall not unref
this object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_get_entry_by_annotation ()">
<a name="polkit-policy-cache-get-entry-by-annotation"></a><h3>polkit_policy_cache_get_entry_by_annotation ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="returnvalue">PolKitPolicyFileEntry</span></a>* polkit_policy_cache_get_entry_by_annotation
(<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *annotation_key</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *annotation_value</code></em>);</pre>
<p>
Find the first policy file entry where a given annotation matches a
given value. Note that there is nothing preventing the existence of
multiple policy file entries matching this criteria; it would
however be a packaging bug if this situation occured.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the policy cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>annotation_key</code></em> :</span></p></td>
<td>the key to check for
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>annotation_value</code></em> :</span></p></td>
<td>the value to check for
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The first <a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> matching the search
criteria. The caller shall not unref this object. Returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if
there are no policy file entries matching the search criteria.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.7</p>
</div>
<hr>
<div class="refsect2" title="polkit_policy_cache_foreach ()">
<a name="polkit-policy-cache-foreach"></a><h3>polkit_policy_cache_foreach ()</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_policy_cache_foreach (<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCache" title="PolKitPolicyCache"><span class="type">PolKitPolicyCache</span></a> *policy_cache</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-Cache.html#PolKitPolicyCacheForeachFunc" title="PolKitPolicyCacheForeachFunc ()"><span class="type">PolKitPolicyCacheForeachFunc</span></a> callback</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Visit all entries in the policy cache.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_cache</code></em> :</span></p></td>
<td>the policy cache
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
<td>callback function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data to pass to callback function
</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> only if iteration was short-circuited
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
ACC SHELL 2018