/usr/share/gtk-doc/html/libgwyapp/libgwyapp-funcuse.html is in libgwyddion20-doc 2.34-3ubuntu1.
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 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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Application Library Reference Manual: funcuse</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Application Library Reference Manual">
<link rel="prev" href="libgwyapp-filelist.html" title="filelist">
<link rel="next" href="GwyResourceEditor.html" title="GwyResourceEditor">
<meta name="generator" content="GTK-Doc V1.19 (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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#libgwyapp-funcuse.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyapp-filelist.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyResourceEditor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyapp-funcuse"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyapp-funcuse.top_of_page"></a>funcuse</span></h2>
<p>funcuse — Gather function use statistics</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyapp-funcuse.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <app/gwyapp.h>
<a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="returnvalue">GwyFunctionUse</span></a> * <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-new" title="gwy_func_use_new ()">gwy_func_use_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-free" title="gwy_func_use_free ()">gwy_func_use_free</a> (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-add" title="gwy_func_use_add ()">gwy_func_use_add</a> (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-get" title="gwy_func_use_get ()">gwy_func_use_get</a> (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);
<a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="returnvalue">GwyFunctionUse</span></a> * <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-load" title="gwy_func_use_load ()">gwy_func_use_load</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-save" title="gwy_func_use_save ()">gwy_func_use_save</a> (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="libgwyapp-funcuse.html#gwy-func-use-get-filename" title="gwy_func_use_get_filename ()">gwy_func_use_get_filename</a> (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>);
<a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="returnvalue">GwyFunctionUse</span></a> * <a class="link" href="libgwyapp-funcuse.html#gwy-app-process-func-get-use" title="gwy_app_process_func_get_use ()">gwy_app_process_func_get_use</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwyapp-funcuse.html#gwy-app-process-func-save-use" title="gwy_app_process_func_save_use ()">gwy_app_process_func_save_use</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse">GwyFunctionUse</a>;
</pre>
</div>
<div class="refsect1">
<a name="libgwyapp-funcuse.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libgwyapp-funcuse.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gwy-func-use-new"></a><h3>gwy_func_use_new ()</h3>
<pre class="programlisting"><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="returnvalue">GwyFunctionUse</span></a> * gwy_func_use_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates new function use statistics.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created function use statistics.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-func-use-free"></a><h3>gwy_func_use_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_func_use_free (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>);</pre>
<p>
Destroys function use statistics, freeing all associated resourced.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>functions</code></em> :</span></p></td>
<td>Function use statistics.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-func-use-add"></a><h3>gwy_func_use_add ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_func_use_add (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *name</code></em>);</pre>
<p>
Adds an use of a function to the statistics.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>functions</code></em> :</span></p></td>
<td>Function use statistics.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>Function name.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-func-use-get"></a><h3>gwy_func_use_get ()</h3>
<pre class="programlisting">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_func_use_get (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> i</code></em>);</pre>
<p>
Gets the n-th most function from a function statistics.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>functions</code></em> :</span></p></td>
<td>Function use statistics.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td>Position in the top used functions (starting from 0).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The function name, or <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there are not more functions with
use statistics records than <em class="parameter"><code>i</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-func-use-load"></a><h3>gwy_func_use_load ()</h3>
<pre class="programlisting"><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="returnvalue">GwyFunctionUse</span></a> * gwy_func_use_load (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>
Loads function use statistics from a file.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>A file name (in GLib encoding).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created function use statistics filled with data from
file <em class="parameter"><code>filename</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-func-use-save"></a><h3>gwy_func_use_save ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_func_use_save (<em class="parameter"><code><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="type">GwyFunctionUse</span></a> *functions</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
<p>
Saves function use statistics data to a file.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>functions</code></em> :</span></p></td>
<td>Function use statistics.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>A file name (in GLib encoding).</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-func-use-get-filename"></a><h3>gwy_func_use_get_filename ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_func_use_get_filename (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>);</pre>
<p>
Gets the (preferred) name for a file to store function use statistics to.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>Function type, that is an identifier of the type of statistics
gathered. It must be a valid identifier.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The file name as a newly allocated string.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-process-func-get-use"></a><h3>gwy_app_process_func_get_use ()</h3>
<pre class="programlisting"><a class="link" href="libgwyapp-funcuse.html#GwyFunctionUse" title="GwyFunctionUse"><span class="returnvalue">GwyFunctionUse</span></a> * gwy_app_process_func_get_use (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-app-process-func-save-use"></a><h3>gwy_app_process_func_save_use ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_app_process_func_save_use (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Saves application data processing function statistics.
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwyFunctionUse"></a><h3>GwyFunctionUse</h3>
<pre class="programlisting">typedef struct _GwyFunctionUse GwyFunctionUse;</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|