This file is indexed.

/usr/share/gtk-doc/html/ctpl/ctpl-CtplOutputStream.html is in libctpl-doc 0.3.3.dfsg-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
247
248
249
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CtplOutputStream</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="CTPL Reference Manual">
<link rel="up" href="ch02.html" title="API reference">
<link rel="prev" href="ctpl-CtplInputStream.html" title="CtplInputStream">
<link rel="next" href="api-index-full.html" title="API Index">
<meta name="generator" content="GTK-Doc V1.17 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ctpl-CtplInputStream.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">CTPL Reference Manual</th>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ctpl-CtplOutputStream.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ctpl-CtplOutputStream.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="ctpl-CtplOutputStream"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ctpl-CtplOutputStream.top_of_page"></a>CtplOutputStream</span></h2>
<p>CtplOutputStream — CTPL's data output stream</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ctpl-CtplOutputStream.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;ctpl/ctpl.h&gt;

                    <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream">CtplOutputStream</a>;
<a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="returnvalue">CtplOutputStream</span></a> *  <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-new" title="ctpl_output_stream_new ()">ctpl_output_stream_new</a>              (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> *stream</code></em>);
<a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="returnvalue">CtplOutputStream</span></a> *  <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-ref" title="ctpl_output_stream_ref ()">ctpl_output_stream_ref</a>              (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-unref" title="ctpl_output_stream_unref ()">ctpl_output_stream_unref</a>            (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>);
<a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="returnvalue">GOutputStream</span></a> *     <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-get-stream" title="ctpl_output_stream_get_stream ()">ctpl_output_stream_get_stream</a>       (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-write" title="ctpl_output_stream_write ()">ctpl_output_stream_write</a>            (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-put-c" title="ctpl_output_stream_put_c ()">ctpl_output_stream_put_c</a>            (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> c</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ctpl-CtplOutputStream.description"></a><h2>Description</h2>
<p>
The data output stream used by CTPL; built on top of <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a>.
</p>
<p>
A <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> is created with <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-new" title="ctpl_output_stream_new ()"><code class="function">ctpl_output_stream_new()</code></a>. It uses a
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>-like refcounting, through <a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-ref" title="ctpl_output_stream_ref ()"><code class="function">ctpl_output_stream_ref()</code></a> and
<a class="link" href="ctpl-CtplOutputStream.html#ctpl-output-stream-unref" title="ctpl_output_stream_unref ()"><code class="function">ctpl_output_stream_unref()</code></a>.
</p>
<p>
The errors that the functions in this module can throw comes from the
<a href="/usr/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR:CAPS"><code class="literal">G_IO_ERROR</code></a> or <a class="link" href="ctpl-Generic-IO.html#CTPL-IO-ERROR:CAPS" title="CTPL_IO_ERROR"><code class="literal">CTPL_IO_ERROR</code></a> domains unless otherwise mentioned.
</p>
</div>
<div class="refsect1">
<a name="ctpl-CtplOutputStream.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CtplOutputStream"></a><h3>CtplOutputStream</h3>
<pre class="programlisting">typedef struct _CtplOutputStream CtplOutputStream;</pre>
<p>
An opaque object representing an output data stream.
</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-output-stream-new"></a><h3>ctpl_output_stream_new ()</h3>
<pre class="programlisting"><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="returnvalue">CtplOutputStream</span></a> *  ctpl_output_stream_new              (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> *stream</code></em>);</pre>
<p>
Creates a new <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> for a given <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a>.
This function adds a reference to the <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-output-stream-ref"></a><h3>ctpl_output_stream_ref ()</h3>
<pre class="programlisting"><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="returnvalue">CtplOutputStream</span></a> *  ctpl_output_stream_ref              (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>);</pre>
<p>
Adds a reference to a <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The stream</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-output-stream-unref"></a><h3>ctpl_output_stream_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_output_stream_unref            (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>);</pre>
<p>
Removes a reference from a <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>. When its reference count
reaches 0, the stream is destroyed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-output-stream-get-stream"></a><h3>ctpl_output_stream_get_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="returnvalue">GOutputStream</span></a> *     ctpl_output_stream_get_stream       (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>);</pre>
<p>
Gets the underlying <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> associated with a <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The underlying <a href="/usr/share/gtk-doc/html/gio/GOutputStream.html"><span class="type">GOutputStream</span></a> of <em class="parameter"><code>stream</code></em>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-output-stream-write"></a><h3>ctpl_output_stream_write ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ctpl_output_stream_write            (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *data</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gssize"><span class="type">gssize</span></a> length</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Writes a buffer to a <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The data to write</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>Length of the data in bytes, or -1 if it is a 0-terminated string</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore them</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-output-stream-put-c"></a><h3>ctpl_output_stream_put_c ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ctpl_output_stream_put_c            (<em class="parameter"><code><a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> c</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Writes a character to a <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>c</code></em> :</span></p></td>
<td>The character to write</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore them</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.2</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>