/usr/share/gtk-doc/html/xfconf/xfconf-xfconf.html is in libxfconf-0-dev 4.12.1-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Xfconf Library Core: Xfconf Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Xfconf Reference Manual">
<link rel="up" href="ch03.html" title="Xfconf Client Library">
<link rel="prev" href="ch03.html" title="Xfconf Client Library">
<link rel="next" href="xfconf-xfconf-channel.html" title="XfconfChannel">
<meta name="generator" content="GTK-Doc V1.25.1 (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="#xfconf-xfconf.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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="xfconf-xfconf-channel.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="xfconf-xfconf"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="xfconf-xfconf.top_of_page"></a>Xfconf Library Core</span></h2>
<p>Xfconf Library Core — Init routines and core functionality for libxfconf</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="xfconf-xfconf.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="xfconf-xfconf.html#xfconf-init" title="xfconf_init ()">xfconf_init</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="xfconf-xfconf.html#xfconf-shutdown" title="xfconf_shutdown ()">xfconf_shutdown</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="xfconf-xfconf.html#xfconf-named-struct-register" title="xfconf_named_struct_register ()">xfconf_named_struct_register</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="xfconf-xfconf.html#xfconf-array-free" title="xfconf_array_free ()">xfconf_array_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="xfconf-xfconf.description"></a><h2>Description</h2>
<p>
Before libxfconf can be used, it must be initialized by calling
<a class="link" href="xfconf-xfconf.html#xfconf-init" title="xfconf_init ()"><code class="function">xfconf_init()</code></a>. To free resources used by the library, call
<a class="link" href="xfconf-xfconf.html#xfconf-shutdown" title="xfconf_shutdown ()"><code class="function">xfconf_shutdown()</code></a>. These calls are "recursive": multiple calls to
<a class="link" href="xfconf-xfconf.html#xfconf-init" title="xfconf_init ()"><code class="function">xfconf_init()</code></a> are allowed, but each call must be matched by a
separate call to <a class="link" href="xfconf-xfconf.html#xfconf-shutdown" title="xfconf_shutdown ()"><code class="function">xfconf_shutdown()</code></a> to really free the library's
resources.
</p>
</div>
<div class="refsect1">
<a name="xfconf-xfconf.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfconf-init"></a><h3>xfconf_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
xfconf_init (<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Initializes the Xfconf library. Can be called multiple times with no
adverse effects.</p>
<div class="refsect3">
<a name="xfconf-init.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>error</p></td>
<td class="parameter_description"><p>An error return.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfconf-init.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the library was initialized succesfully, <code class="literal">FALSE</code> on
error. If there is an error <em class="parameter"><code>error</code></em>
will be set.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-shutdown"></a><h3>xfconf_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfconf_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Shuts down and frees any resources consumed by the Xfconf library.
If <a class="link" href="xfconf-xfconf.html#xfconf-init" title="xfconf_init ()"><code class="function">xfconf_init()</code></a> is called multiple times, <a class="link" href="xfconf-xfconf.html#xfconf-shutdown" title="xfconf_shutdown ()"><code class="function">xfconf_shutdown()</code></a> must be
called an equal number of times to shut down the library.</p>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-named-struct-register"></a><h3>xfconf_named_struct_register ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfconf_named_struct_register (<em class="parameter"><code>const <span class="type">gchar</span> *struct_name</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_members</code></em>,
<em class="parameter"><code>const <span class="type">GType</span> *member_types</code></em>);</pre>
<p>Registers a named struct for use with <a class="link" href="xfconf-xfconf-channel.html#xfconf-channel-get-named-struct" title="xfconf_channel_get_named_struct ()"><code class="function">xfconf_channel_get_named_struct()</code></a>
and <a class="link" href="xfconf-xfconf-channel.html#xfconf-channel-set-named-struct" title="xfconf_channel_set_named_struct ()"><code class="function">xfconf_channel_set_named_struct()</code></a>.</p>
<div class="refsect3">
<a name="xfconf-named-struct-register.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>struct_name</p></td>
<td class="parameter_description"><p>The unique name of the struct to register.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_members</p></td>
<td class="parameter_description"><p>The number of data members in the struct.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>member_types</p></td>
<td class="parameter_description"><p>An array of the <span class="type">GType</span>s of the struct members.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="xfconf-array-free"></a><h3>xfconf_array_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfconf_array_free (<em class="parameter"><code><span class="type">GPtrArray</span> *arr</code></em>);</pre>
<p>Properly frees a <span class="type">GPtrArray</span> structure containing a list of
<span class="type">GValue</span>s. This will also cause the contents of the
values to be freed as well.</p>
<div class="refsect3">
<a name="xfconf-array-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>arr</p></td>
<td class="parameter_description"><p>A <span class="type">GPtrArray</span> of <span class="type">GValue</span>s.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="xfconf-xfconf.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>
|