This file is indexed.

/usr/share/gtk-doc/html/ctpl/ctpl-Generic-IO.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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Generic IO</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-CtplEval.html" title="CtplEval">
<link rel="next" href="ctpl-CtplInputStream.html" title="CtplInputStream">
<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-CtplEval.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="ctpl-CtplInputStream.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-Generic-IO.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ctpl-Generic-IO.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="ctpl-Generic-IO"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ctpl-Generic-IO.top_of_page"></a>Generic IO</span></h2>
<p>Generic IO — CTPL's IO layer</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ctpl-Generic-IO.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;ctpl/ctpl.h&gt;

enum                <a class="link" href="ctpl-Generic-IO.html#CtplIOError" title="enum CtplIOError">CtplIOError</a>;
#define             <a class="link" href="ctpl-Generic-IO.html#CTPL-IO-ERROR:CAPS" title="CTPL_IO_ERROR">CTPL_IO_ERROR</a>
</pre>
</div>
<div class="refsect1">
<a name="ctpl-Generic-IO.description"></a><h2>Description</h2>
<p>
See the two sub-modules <a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a> and <a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a>.
</p>
</div>
<div class="refsect1">
<a name="ctpl-Generic-IO.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CtplIOError"></a><h3>enum CtplIOError</h3>
<pre class="programlisting">typedef enum _CtplIOError
{
  CTPL_IO_ERROR_EOF,
  CTPL_IO_ERROR_INVALID_NUMBER,
  CTPL_IO_ERROR_INVALID_STRING,
  CTPL_IO_ERROR_RANGE,
  CTPL_IO_ERROR_FAILED
} CtplIOError;
</pre>
<p>
Errors that can be thrown by I/O functions (<a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a> and
<a class="link" href="ctpl-CtplOutputStream.html#CtplOutputStream" title="CtplOutputStream"><span class="type">CtplOutputStream</span></a> methods), from the <a class="link" href="ctpl-Generic-IO.html#CTPL-IO-ERROR:CAPS" title="CTPL_IO_ERROR"><code class="literal">CTPL_IO_ERROR</code></a> domain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="CTPL-IO-ERROR-EOF:CAPS"></a><span class="term"><code class="literal">CTPL_IO_ERROR_EOF</code></span></p></td>
<td>End of the stream unexpectedly reached
</td>
</tr>
<tr>
<td><p><a name="CTPL-IO-ERROR-INVALID-NUMBER:CAPS"></a><span class="term"><code class="literal">CTPL_IO_ERROR_INVALID_NUMBER</code></span></p></td>
<td>The stream doesn't contain a valid number
                               recognized by the function that threw it
</td>
</tr>
<tr>
<td><p><a name="CTPL-IO-ERROR-INVALID-STRING:CAPS"></a><span class="term"><code class="literal">CTPL_IO_ERROR_INVALID_STRING</code></span></p></td>
<td>The stream doesn't contain a valid string
                               literal
</td>
</tr>
<tr>
<td><p><a name="CTPL-IO-ERROR-RANGE:CAPS"></a><span class="term"><code class="literal">CTPL_IO_ERROR_RANGE</code></span></p></td>
<td>A numeric conversion would overflow
</td>
</tr>
<tr>
<td><p><a name="CTPL-IO-ERROR-FAILED:CAPS"></a><span class="term"><code class="literal">CTPL_IO_ERROR_FAILED</code></span></p></td>
<td>Something went wrong
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CTPL-IO-ERROR:CAPS"></a><h3>CTPL_IO_ERROR</h3>
<pre class="programlisting">#define CTPL_IO_ERROR   (ctpl_io_error_quark ())
</pre>
<p>
Error domain for <a class="link" href="ctpl-Generic-IO.html#CtplIOError" title="enum CtplIOError"><span class="type">CtplIOError</span></a>s.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>