This file is indexed.

/usr/share/gtk-doc/html/libinstpatch/IpatchDLSWriter.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>IpatchDLSWriter</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="ch04.html" title="DLS patches">
<link rel="prev" href="IpatchDLSReader.html" title="IpatchDLSReader">
<link rel="next" href="IpatchDLS2Inst.html" title="IpatchDLS2Inst">
<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="IpatchDLSReader.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.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="IpatchDLS2Inst.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#IpatchDLSWriter.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#IpatchDLSWriter.description" class="shortcut">Description</a>
                 | 
                <a href="#IpatchDLSWriter.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" title="IpatchDLSWriter">
<a name="IpatchDLSWriter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="IpatchDLSWriter.top_of_page"></a>IpatchDLSWriter</span></h2>
<p>IpatchDLSWriter — DLS instrument file writer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="IpatchDLSWriter.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="IpatchDLSWriter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a
href="../libinstpatch/IpatchDLSWriter.html#IpatchDLSWriter-struct"
>IpatchDLSWriter</a>;
<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *   <a
href="../libinstpatch/IpatchDLSWriter.html#ipatch-dls-writer-new"
>ipatch_dls_writer_new</a>               (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchDLS2.html"
>IpatchDLS2</a> *dls);
void                <a
href="../libinstpatch/IpatchDLSWriter.html#ipatch-dls-writer-set-patch"
>ipatch_dls_writer_set_patch</a>         (<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *writer,
                                                         <a
href="../libinstpatch/IpatchDLS2.html"
>IpatchDLS2</a> *dls);
void                <a
href="../libinstpatch/IpatchDLSWriter.html#ipatch-dls-writer-set-file-handle"
>ipatch_dls_writer_set_file_handle</a>   (<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *writer,
                                                         <a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a
href="../libinstpatch/IpatchDLSWriter.html#ipatch-dls-writer-save"
>ipatch_dls_writer_save</a>              (<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *writer,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="IpatchDLSWriter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
   +----<a
href="../libinstpatch/IpatchRiff.html"
>IpatchRiff</a>
         +----IpatchDLSWriter
</pre>
</div>
<div class="refsect1" title="Description">
<a name="IpatchDLSWriter.description"></a><h2>Description</h2>
<p>
Writes a DLS instrument object tree (<span class="type">IpatchDLS</span>) to a DLS file.</p>
</div>
<div class="refsect1" title="Details">
<a name="IpatchDLSWriter.details"></a><h2>Details</h2>
<div class="refsect2" title="IpatchDLSWriter">
<a name="IpatchDLSWriter-struct"></a><h3>IpatchDLSWriter</h3>
<pre class="programlisting">typedef struct _IpatchDLSWriter IpatchDLSWriter;</pre>
</div>
<hr>
<div class="refsect2" title="ipatch_dls_writer_new ()">
<a name="ipatch-dls-writer-new"></a><h3>ipatch_dls_writer_new ()</h3>
<pre class="programlisting"><a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *   ipatch_dls_writer_new               (<a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle,
                                                         <a
href="../libinstpatch/IpatchDLS2.html"
>IpatchDLS2</a> *dls);</pre>
<p>
Create a new DLS file writer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> DLS file handle to save to or <code class="literal">NULL</code> to set later, taken over by
  writer object and will be closed on finalize.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls</code></em> :</span></p></td>
<td> DLS object to save or <code class="literal">NULL</code> to set later
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> The new DLS writer
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_dls_writer_set_patch ()">
<a name="ipatch-dls-writer-set-patch"></a><h3>ipatch_dls_writer_set_patch ()</h3>
<pre class="programlisting">void                ipatch_dls_writer_set_patch         (<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *writer,
                                                         <a
href="../libinstpatch/IpatchDLS2.html"
>IpatchDLS2</a> *dls);</pre>
<p>
Set the DLS patch object to save with a DLS writer.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
<td> DLS writer object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dls</code></em> :</span></p></td>
<td> DLS patch to save
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_dls_writer_set_file_handle ()">
<a name="ipatch-dls-writer-set-file-handle"></a><h3>ipatch_dls_writer_set_file_handle ()</h3>
<pre class="programlisting">void                ipatch_dls_writer_set_file_handle   (<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *writer,
                                                         <a
href="../libinstpatch/IpatchFile.html#IpatchFileHandle"
>IpatchFileHandle</a> *handle);</pre>
<p>
Set the DLS file handle of a DLS writer. A convenience function, since
<a
href="../libinstpatch/IpatchRiff.html#ipatch-riff-set-file-handle"
><code class="function">ipatch_riff_set_file_handle()</code></a> could also be used.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
<td> DLS writer object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td> DLS file handle
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="ipatch_dls_writer_save ()">
<a name="ipatch-dls-writer-save"></a><h3>ipatch_dls_writer_save ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"
>gboolean</a>            ipatch_dls_writer_save              (<a
href="../libinstpatch/IpatchDLSWriter.html"
>IpatchDLSWriter</a> *writer,
                                                         <a
href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"
>GError</a> **err);</pre>
<p>
Write a DLS or GigaSampler object to a file.</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>writer</code></em> :</span></p></td>
<td> DLS writer object
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td> Location to store error info 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> <code class="literal">TRUE</code> on success, <code class="literal">FALSE</code> on error
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" title="See Also">
<a name="IpatchDLSWriter.see-also"></a><h2>See Also</h2>
#IpatchDLS
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>