This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/libinstpatch-misc.html is in libinstpatch-doc 1.0.0-7.

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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>misc</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<link rel="home" href="index.html" title="libinstpatch Reference Manual">
<link rel="up" href="ch02.html" title="Utility objects and functions">
<link rel="prev" href="libinstpatch-md5.html" title="md5">
<link rel="next" href="libinstpatch-util.html" title="util">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Base objects and functions">
<link rel="chapter" href="ch02.html" title="Utility objects and functions">
<link rel="chapter" href="ch03.html" title="Sample data objects and functions">
<link rel="chapter" href="ch04.html" title="DLS patches">
<link rel="chapter" href="ch05.html" title="SoundFont patches">
<link rel="chapter" href="ch06.html" title="GigaSampler patches">
<link rel="chapter" href="ch07.html" title="Virtual banks">
<link rel="chapter" href="object-tree.html" title="Object Hierarchy">
<link rel="index" href="api-index-full.html" title="API Index">
</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="libinstpatch-md5.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.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">libinstpatch Reference Manual</th>
<td><a accesskey="n" href="libinstpatch-util.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libinstpatch-misc.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#libinstpatch-misc.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="misc">
<a name="libinstpatch-misc"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinstpatch-misc.top_of_page"></a>misc</span></h2>
<p>misc — Miscellaneous stuff</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="libinstpatch-misc.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="libinstpatch-misc.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#define             <a
href="../libinstpatch/libinstpatch-misc.html#IPATCH-ERROR--CAPS"
>IPATCH_ERROR</a>
enum                <a
href="../libinstpatch/libinstpatch-misc.html#IpatchError"
>IpatchError</a>;
#define             <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-code-error"
>ipatch_code_error</a>                   (...)
extern              char *<a
href="../libinstpatch/libinstpatch-misc.html#ipatch-application-name"
>ipatch_application_name</a>;
void                <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-init"
>ipatch_init</a>                         (void);
void                <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-set-application-name"
>ipatch_set_application_name</a>         (const char *name);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"
>GQuark</a>              <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-error-quark"
>ipatch_error_quark</a>                  (void);
const char *        <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-gerror-message"
>ipatch_gerror_message</a>               (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> *err);
void                <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-strconcat-num"
>ipatch_strconcat_num</a>                (const char *src,
                                                         int num,
                                                         char *dest,
                                                         int size);
void                <a
href="../libinstpatch/libinstpatch-misc.html#ipatch-dump-object"
>ipatch_dump_object</a>                  (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> recursive,
                                                         FILE *file);
</pre>
</div>
<div class="refsect1" title="Description">
<a name="libinstpatch-misc.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="libinstpatch-misc.details"></a><h2>Details</h2>
<div class="refsect2" title="IPATCH_ERROR">
<a name="IPATCH-ERROR--CAPS"></a><h3>IPATCH_ERROR</h3>
<pre class="programlisting">#define IPATCH_ERROR  ipatch_error_quark()
</pre>
</div>
<hr>
<div class="refsect2" title="enum IpatchError">
<a name="IpatchError"></a><h3>enum IpatchError</h3>
<pre class="programlisting">typedef enum
{
  IPATCH_ERROR_FAIL,		/* a general failure */
  IPATCH_ERROR_IO,		/* I/O error (file operations, etc) */
  IPATCH_ERROR_PROGRAM,		/* a programming error */
  IPATCH_ERROR_INVALID,		/* invalid parameter or data */
  IPATCH_ERROR_CORRUPT,		/* corrupted data */
  IPATCH_ERROR_NOMEM,		/* out of memory error */
  IPATCH_ERROR_UNSUPPORTED,	/* unsupported feature */
  IPATCH_ERROR_UNEXPECTED_EOF,	/* unexpected end of file */
  IPATCH_ERROR_UNHANDLED_CONVERSION	/* unhandled object conversion */
} IpatchError;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_code_error()">
<a name="ipatch-code-error"></a><h3>ipatch_code_error()</h3>
<pre class="programlisting">#define             ipatch_code_error(...)</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_application_name">
<a name="ipatch-application-name"></a><h3>ipatch_application_name</h3>
<pre class="programlisting">extern char *ipatch_application_name;
</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_init ()">
<a name="ipatch-init"></a><h3>ipatch_init ()</h3>
<pre class="programlisting">void                ipatch_init                         (void);</pre>
<p>
Initialize libInstPatch library. Should be called before any other
libInstPatch related functions.</p>
</div>
<hr>
<div class="refsect2" title="ipatch_set_application_name ()">
<a name="ipatch-set-application-name"></a><h3>ipatch_set_application_name ()</h3>
<pre class="programlisting">void                ipatch_set_application_name         (const char *name);</pre>
<p>
Set the global application name string which is used as the
software string written to patch files. This string should contain
the name of the application, and its version, that is using
libInstPatch. The libInstPatch version will also be output where
appropriate, so the software string written to a SoundFont for
example would look something like "swami 1.0 (libInstPatch 1.0)".</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> Application name and version (example: "swami 1.0") or <code class="literal">NULL</code> to
  unset application name
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_error_quark ()">
<a name="ipatch-error-quark"></a><h3>ipatch_error_quark ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Quarks.html#GQuark"
>GQuark</a>              ipatch_error_quark                  (void);</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_gerror_message ()">
<a name="ipatch-gerror-message"></a><h3>ipatch_gerror_message ()</h3>
<pre class="programlisting">const char *        ipatch_gerror_message               (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> *err);</pre>
<p>
A utility function to check if a GError is set and return the
GError's message field if it is, or a string explaining that there
isn't any error info if <em class="parameter"><code>err</code></em> is <code class="literal">NULL</code>.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> A GError object or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The GError's message or a "&lt;No detailed error information&gt;" string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_strconcat_num ()">
<a name="ipatch-strconcat-num"></a><h3>ipatch_strconcat_num ()</h3>
<pre class="programlisting">void                ipatch_strconcat_num                (const char *src,
                                                         int num,
                                                         char *dest,
                                                         int size);</pre>
<p>
Creates a string with a number appended to it but ensures that it is
of the specified <em class="parameter"><code>size</code></em> (including NULL termination). Characters in the
middle of the string are removed and a ".." is inserted, if necessary.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>src</code></em> :</span></p></td>
<td> Source string
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>num</code></em> :</span></p></td>
<td> Number to concatenate
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dest</code></em> :</span></p></td>
<td> Destination buffer
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td> Size of destination buffer
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_dump_object ()">
<a name="ipatch-dump-object"></a><h3>ipatch_dump_object ()</h3>
<pre class="programlisting">void                ipatch_dump_object                  (<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a> *object,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a> recursive,
                                                         FILE *file);</pre>
<p>
Dumps object info to a file for debugging purposes.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
<td> Object to dump
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>recursive</code></em> :</span></p></td>
<td> Set to <code class="literal">TRUE</code> to recurse the <em class="parameter"><code>object</code></em> children (if its a
  <a
href="../libinstpatch/IpatchContainer.html"
><span class="type">IpatchContainer</span></a> derived object).
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>file</code></em> :</span></p></td>
<td> File to dump to or <code class="literal">NULL</code> for stdout
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>