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 Definition Files</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-Configuration.html" title="Configuration">
<link rel="next" href="polkit-Policy-File-Entry.html" title="Policy File 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-Configuration.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-Policy-File-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-Definition-Files.synopsis" class="shortcut">Top</a>
|
<a href="#polkit-Policy-Definition-Files.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="Policy Definition Files">
<a name="polkit-Policy-Definition-Files"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="polkit-Policy-Definition-Files.top_of_page"></a>Policy Definition Files</span></h2>
<p>Policy Definition Files — Represents a set of declared actions.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="polkit-Policy-Definition-Files.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile">PolKitPolicyFile</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-Definition-Files.html#PolKitPolicyFileEntryForeachFunc" title="PolKitPolicyFileEntryForeachFunc ()">*PolKitPolicyFileEntryForeachFunc</a>) (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> *policy_file_entry</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);
<a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="returnvalue">PolKitPolicyFile</span></a> * <a class="link" href="polkit-Policy-Definition-Files.html#polkit-policy-file-new" title="polkit_policy_file_new ()">polkit_policy_file_new</a> (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="type">polkit_bool_t</span></a> load_descriptions</code></em>,
<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-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="returnvalue">PolKitPolicyFile</span></a> * <a class="link" href="polkit-Policy-Definition-Files.html#polkit-policy-file-ref" title="polkit_policy_file_ref ()">polkit_policy_file_ref</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</code></em>);
<span class="returnvalue">void</span> <a class="link" href="polkit-Policy-Definition-Files.html#polkit-policy-file-unref" title="polkit_policy_file_unref ()">polkit_policy_file_unref</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</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-Definition-Files.html#polkit-policy-file-entry-foreach" title="polkit_policy_file_entry_foreach ()">polkit_policy_file_entry_foreach</a> (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFileEntryForeachFunc" title="PolKitPolicyFileEntryForeachFunc ()"><span class="type">PolKitPolicyFileEntryForeachFunc</span></a> cb</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-Definition-Files.description"></a><h2>Description</h2>
<p>
This class is used to represent a policy file.
</p>
</div>
<div class="refsect1" title="Details">
<a name="polkit-Policy-Definition-Files.details"></a><h2>Details</h2>
<div class="refsect2" title="PolKitPolicyFile">
<a name="PolKitPolicyFile"></a><h3>PolKitPolicyFile</h3>
<pre class="programlisting">typedef struct _PolKitPolicyFile PolKitPolicyFile;</pre>
<p>
Objects of this class are used to record information about a
policy file.
</p>
</div>
<hr>
<div class="refsect2" title="PolKitPolicyFileEntryForeachFunc ()">
<a name="PolKitPolicyFileEntryForeachFunc"></a><h3>PolKitPolicyFileEntryForeachFunc ()</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> (*PolKitPolicyFileEntryForeachFunc) (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-File-Entry.html#PolKitPolicyFileEntry" title="PolKitPolicyFileEntry"><span class="type">PolKitPolicyFileEntry</span></a> *policy_file_entry</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Type for function used in <a class="link" href="polkit-Policy-Definition-Files.html#polkit-policy-file-entry-foreach" title="polkit_policy_file_entry_foreach ()"><code class="function">polkit_policy_file_entry_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_file</code></em> :</span></p></td>
<td>the policy file
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_file_entry</code></em> :</span></p></td>
<td>the entry
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data
</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_file_new ()">
<a name="polkit-policy-file-new"></a><h3>polkit_policy_file_new ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="returnvalue">PolKitPolicyFile</span></a> * polkit_policy_file_new (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Basic-types.html#polkit-bool-t" title="polkit_bool_t"><span class="type">polkit_bool_t</span></a> load_descriptions</code></em>,
<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>
Load a policy file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>path to file
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>load_descriptions</code></em> :</span></p></td>
<td>whether descriptions should be loaded
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for error
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new object or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> if error is set
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_file_ref ()">
<a name="polkit-policy-file-ref"></a><h3>polkit_policy_file_ref ()</h3>
<pre class="programlisting"><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="returnvalue">PolKitPolicyFile</span></a> * polkit_policy_file_ref (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</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_file</code></em> :</span></p></td>
<td>the policy file 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_file_unref ()">
<a name="polkit-policy-file-unref"></a><h3>polkit_policy_file_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> polkit_policy_file_unref (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</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_file</code></em> :</span></p></td>
<td>the policy file object
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="polkit_policy_file_entry_foreach ()">
<a name="polkit-policy-file-entry-foreach"></a><h3>polkit_policy_file_entry_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_file_entry_foreach (<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFile" title="PolKitPolicyFile"><span class="type">PolKitPolicyFile</span></a> *policy_file</code></em>,
<em class="parameter"><code><a class="link" href="polkit-Policy-Definition-Files.html#PolKitPolicyFileEntryForeachFunc" title="PolKitPolicyFileEntryForeachFunc ()"><span class="type">PolKitPolicyFileEntryForeachFunc</span></a> cb</code></em>,
<em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
<p>
Visits all entries in a policy file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>policy_file</code></em> :</span></p></td>
<td>the policy file object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cb</code></em> :</span></p></td>
<td>callback to invoke for each entry
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data
</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 the 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