libinfinity-0.7-doc 0.7.1-1 / usr / share / gtk-doc / html / libinfinoted-plugin-manager-0.7 / libinfinoted-plugin-manager-0.7-InfinotedUtil.html

This file is indexed.

/usr/share/gtk-doc/html/libinfinoted-plugin-manager-0.7/libinfinoted-plugin-manager-0.7-InfinotedUtil.html is in libinfinity-0.7-doc 0.7.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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfinotedUtil: libinfinoted-plugin-manager-0.7 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinoted-plugin-manager-0.7 Reference Manual">
<link rel="up" href="ch01.html" title="libinfinoted-plugin-manager API reference">
<link rel="prev" href="InfinotedLog.html" title="InfinotedLog">
<link rel="next" href="annotation-glossary.html" title="Annotation Glossary">
<meta name="generator" content="GTK-Doc V1.25 (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="#libinfinoted-plugin-manager-0.7-InfinotedUtil.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfinotedLog.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="annotation-glossary.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.top_of_page"></a>InfinotedUtil</span></h2>
<p>InfinotedUtil — Miscellaneous helper functions.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.stability-level"></a><h2>Stability Level</h2>
<acronym title="Unstable interfaces are experimental or transitional. They are typically used to
give outside developers early access to new or rapidly changing technology, or
to provide an interim solution to a problem where a more general solution is
anticipated. No claims are made about either source or binary compatibility from
one minor release to the next.

The Unstable interface level is a warning that these interfaces are  subject to
change without warning and should not be used in unbundled products.

Given such caveats, customer impact need not be a factor when considering
incompatible changes to an Unstable interface in a major or minor release.
Nonetheless, when such changes are introduced, the changes should still be
mentioned in the release notes for the affected release.
"><span class="acronym">Unstable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.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="libinfinoted-plugin-manager-0.7-InfinotedUtil.html#infinoted-util-create-dirname" title="infinoted_util_create_dirname ()">infinoted_util_create_dirname</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="libinfinoted-plugin-manager-0.7-InfinotedUtil.html#infinoted-util-set-errno-error" title="infinoted_util_set_errno_error ()">infinoted_util_set_errno_error</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="libinfinoted-plugin-manager-0.7-InfinotedUtil.html#infinoted-util-daemon-set-global-pid-file-proc" title="infinoted_util_daemon_set_global_pid_file_proc ()">infinoted_util_daemon_set_global_pid_file_proc</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="libinfinoted-plugin-manager-0.7-InfinotedUtil.html#infinoted-util-daemon-set-local-pid-file-proc" title="infinoted_util_daemon_set_local_pid_file_proc ()">infinoted_util_daemon_set_local_pid_file_proc</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">int</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.7-InfinotedUtil.html#infinoted-util-daemon-pid-file-kill" title="infinoted_util_daemon_pid_file_kill ()">infinoted_util_daemon_pid_file_kill</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;infinoted/infinoted-util.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.description"></a><h2>Description</h2>
<p>This section contains a few helper functions that are used in the
infinoted implementation and are exposed to the plugin interface for
convenience of plugin developers.</p>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="infinoted-util-create-dirname"></a><h3>infinoted_util_create_dirname ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_util_create_dirname (<em class="parameter"><code>const <span class="type">gchar</span> *path</code></em>,
                               <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Creates directories leading to the given path. Does not create a directory
for the last component of the path, assuming that it is a filename that
you are going to write into that directory later.</p>
<div class="refsect3">
<a name="infinoted-util-create-dirname.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>path</p></td>
<td class="parameter_description"><p> The filename to create a path to. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> filename]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-util-create-dirname.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> on error in which case <em class="parameter"><code>error</code></em>
is set.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-util-set-errno-error"></a><h3>infinoted_util_set_errno_error ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infinoted_util_set_errno_error (<em class="parameter"><code><span class="type">GError</span> **error</code></em>,
                                <em class="parameter"><code><span class="type">int</span> save_errno</code></em>,
                                <em class="parameter"><code>const <span class="type">char</span> *prefix</code></em>);</pre>
<p>Sets <em class="parameter"><code>error</code></em>
 to <em class="parameter"><code>save_errno</code></em>
 with domain ERRNO_ERROR. If <em class="parameter"><code>prefix</code></em>
 is
non-<code class="literal">NULL</code>, <em class="parameter"><code>prefix</code></em>
 is prefixed to <em class="parameter"><code>error</code></em>
's message, obtained by <code class="function">strerror()</code>.</p>
<div class="refsect3">
<a name="infinoted-util-set-errno-error.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>A pointer to a <span class="type">GError</span> pointer, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>save_errno</p></td>
<td class="parameter_description"><p>An errno variable.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>prefix</p></td>
<td class="parameter_description"><p> A prefix string, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-util-daemon-set-global-pid-file-proc"></a><h3>infinoted_util_daemon_set_global_pid_file_proc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infinoted_util_daemon_set_global_pid_file_proc
                               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>When attempting to read or write the PID file use the global file.</p>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-util-daemon-set-local-pid-file-proc"></a><h3>infinoted_util_daemon_set_local_pid_file_proc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infinoted_util_daemon_set_local_pid_file_proc
                               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>When attempting to read or write the PID file use the local file which is
in the owner's home directory.</p>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-util-daemon-pid-file-kill"></a><h3>infinoted_util_daemon_pid_file_kill ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>
infinoted_util_daemon_pid_file_kill (<em class="parameter"><code><span class="type">int</span> sig</code></em>);</pre>
<p>This is a thin wrapper for <code class="function"><code class="function">daemon_pid_file_kill()</code></code>
which uses <code class="function"><code class="function">daemon_pid_file_kill_wait()</code></code> if available
with a timeout of 5 seconds.</p>
<div class="refsect3">
<a name="infinoted-util-daemon-pid-file-kill.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>sig</p></td>
<td class="parameter_description"><p>The signal to send to the daemon process.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-util-daemon-pid-file-kill.returns"></a><h4>Returns</h4>
<p> 0 if the signal was sent or nonzero otherwise.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.7-InfinotedUtil.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.