/usr/share/gtk-doc/html/camel/CamelOfflineJournal.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CamelOfflineJournal</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Folders.html" title="Folders">
<link rel="prev" href="CamelOfflineFolder.html" title="CamelOfflineFolder">
<link rel="next" href="Search-Folders.html" title="Search Folders">
<meta name="generator" content="GTK-Doc V1.18 (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="CamelOfflineFolder.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Folders.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">Camel Reference Manual</th>
<td><a accesskey="n" href="Search-Folders.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#CamelOfflineJournal.synopsis" class="shortcut">Top</a>
|
<a href="#CamelOfflineJournal.description" class="shortcut">Description</a>
|
<a href="#CamelOfflineJournal.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="CamelOfflineJournal"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="CamelOfflineJournal.top_of_page"></a>CamelOfflineJournal</span></h2>
<p>CamelOfflineJournal</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="CamelOfflineJournal.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="CamelOfflineJournal.html#CamelOfflineJournal-struct" title="struct CamelOfflineJournal">CamelOfflineJournal</a>;
<a class="link" href="CamelOfflineJournal.html#CamelOfflineJournalEntry" title="CamelOfflineJournalEntry">CamelOfflineJournalEntry</a>;
<span class="returnvalue">void</span> <a class="link" href="CamelOfflineJournal.html#camel-offline-journal-construct" title="camel_offline_journal_construct ()">camel_offline_journal_construct</a> (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">void</span> <a class="link" href="CamelOfflineJournal.html#camel-offline-journal-set-filename" title="camel_offline_journal_set_filename ()">camel_offline_journal_set_filename</a> (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelOfflineJournal.html#camel-offline-journal-write" title="camel_offline_journal_write ()">camel_offline_journal_write</a> (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gint</span> <a class="link" href="CamelOfflineJournal.html#camel-offline-journal-replay" title="camel_offline_journal_replay ()">camel_offline_journal_replay</a> (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="CamelOfflineJournal.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----<a class="link" href="CamelObject.html" title="CamelObject">CamelObject</a>
+----CamelOfflineJournal
</pre>
</div>
<div class="refsect1">
<a name="CamelOfflineJournal.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="CamelOfflineJournal.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CamelOfflineJournal-struct"></a><h3>struct CamelOfflineJournal</h3>
<pre class="programlisting">struct CamelOfflineJournal;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CamelOfflineJournalEntry"></a><h3>CamelOfflineJournalEntry</h3>
<pre class="programlisting">typedef struct _CamelOfflineJournalEntry CamelOfflineJournalEntry;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-offline-journal-construct"></a><h3>camel_offline_journal_construct ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_offline_journal_construct (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code><a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> *folder</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Constructs a journal object.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td>a <a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>folder</code></em> :</span></p></td>
<td>a <a class="link" href="CamelFolder.html" title="CamelFolder"><span class="type">CamelFolder</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a filename to save/load the journal</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-offline-journal-set-filename"></a><h3>camel_offline_journal_set_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_offline_journal_set_filename (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
<p>
Set the filename where the journal should load/save from.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td>a <a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a filename to load/save the journal to</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-offline-journal-write"></a><h3>camel_offline_journal_write ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_offline_journal_write (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Save the journal to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td>a <a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, 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">0</code> on success or <code class="literal">-1</code> on fail</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-offline-journal-replay"></a><h3>camel_offline_journal_replay ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span> camel_offline_journal_replay (<em class="parameter"><code><a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> *journal</code></em>,
<em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Replay all entries in the journal.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>journal</code></em> :</span></p></td>
<td>a <a class="link" href="CamelOfflineJournal.html" title="CamelOfflineJournal"><span class="type">CamelOfflineJournal</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <span class="type">GCancellable</span> object, or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>return location for a <span class="type">GError</span>, 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">0</code> on success (no entry failed to replay) or <code class="literal">-1</code> on fail</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|