File: libinftext-0.6-InfTextFilesystemFormat.html

package info (click to toggle)
libinfinity 0.6.5-1
  • links: PTS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 13,528 kB
  • sloc: ansic: 103,421; sh: 11,583; xml: 1,841; makefile: 1,059
file content (268 lines) | stat: -rw-r--r-- 15,880 bytes parent folder | download | duplicates (3) 
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
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>libinftext-0.6 Reference Manual: Storage of text sessions on the file system</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libinftext-0.6 Reference Manual">
<link rel="up" href="ch01.html" title="libinftext API reference">
<link rel="prev" href="InfTextMoveOperation.html" title="InfTextMoveOperation">
<meta name="generator" content="GTK-Doc V1.21 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libinftext-0.6-InfTextFilesystemFormat.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfTextMoveOperation.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><img src="right-insensitive.png" width="16" height="16" border="0"></td>
</tr></table>
<div class="refentry">
<a name="libinftext-0.6-InfTextFilesystemFormat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinftext-0.6-InfTextFilesystemFormat.top_of_page"></a>Storage of text sessions on the file system</span></h2>
<p>Storage of text sessions on the file system — Utility functions to deal with storing
InfTextSessions in filesystem storage</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libinftext-0.6-InfTextFilesystemFormat.html#inf-text-filesystem-format-read" title="inf_text_filesystem_format_read ()">inf_text_filesystem_format_read</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libinftext-0.6-InfTextFilesystemFormat.html#inf-text-filesystem-format-write" title="inf_text_filesystem_format_write ()">inf_text_filesystem_format_write</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libinftext-0.6-InfTextFilesystemFormat.html#InfTextFilesystemFormatError" title="enum InfTextFilesystemFormatError">InfTextFilesystemFormatError</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libinftext/inf-text-filesystem-storage.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.description"></a><h2>Description</h2>
<p>The functions in this section are utility functions that can be used when
implementing a <a href="../libinfinity-0.6/libinfinity-0.6-InfdNotePlugin.html#InfdNotePlugin"><span class="type">InfdNotePlugin</span></a> to handle <a class="link" href="libinftext-0.6-inf-text-session.html#InfTextSession"><span class="type">InfTextSession</span></a>s. These
functions implement reading and writing the content of an <a class="link" href="libinftext-0.6-inf-text-session.html#InfTextSession"><span class="type">InfTextSession</span></a>
to an XML file in the storage.</p>
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="inf-text-filesystem-format-read"></a><h3>inf_text_filesystem_format_read ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
inf_text_filesystem_format_read (<em class="parameter"><code><a href="../libinfinity-0.6/InfdFilesystemStorage.html"><span class="type">InfdFilesystemStorage</span></a> *storage</code></em>,
                                 <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                 <em class="parameter"><code><a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>,
                                 <em class="parameter"><code><a class="link" href="InfTextBuffer.html" title="InfTextBuffer"><span class="type">InfTextBuffer</span></a> *buffer</code></em>,
                                 <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Reads a text session from <em class="parameter"><code>path</code></em>
 in <em class="parameter"><code>storage</code></em>
. The file is expected to have
been saved with <a class="link" href="libinftext-0.6-InfTextFilesystemFormat.html#inf-text-filesystem-format-write" title="inf_text_filesystem_format_write ()"><code class="function">inf_text_filesystem_format_write()</code></a> before. The <em class="parameter"><code>user_table</code></em>

parameter should be an empty user table that will be used for the session,
and the <em class="parameter"><code>buffer</code></em>
 parameter should be an empty <a class="link" href="InfTextBuffer.html" title="InfTextBuffer"><span class="type">InfTextBuffer</span></a>, and the
document will be written into this buffer. If the function succeeds, the
user table and buffer can be used to create an <a class="link" href="libinftext-0.6-inf-text-session.html#InfTextSession"><span class="type">InfTextSession</span></a> with
<a class="link" href="libinftext-0.6-inf-text-session.html#inf-text-session-new-with-user-table" title="inf_text_session_new_with_user_table ()"><code class="function">inf_text_session_new_with_user_table()</code></a>. If the function fails, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is
returned and <em class="parameter"><code>error</code></em>
 is set.</p>
<div class="refsect3">
<a name="id-1.2.15.8.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>storage</p></td>
<td class="parameter_description"><p>A <a href="../libinfinity-0.6/InfdFilesystemStorage.html"><span class="type">InfdFilesystemStorage</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Storage path to retrieve the session from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_table</p></td>
<td class="parameter_description"><p>An empty <a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> to use as the new session's user table.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>An empty <a class="link" href="InfTextBuffer.html" title="InfTextBuffer"><span class="type">InfTextBuffer</span></a> to use as the new session's buffer.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.15.8.2.6"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="inf-text-filesystem-format-write"></a><h3>inf_text_filesystem_format_write ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
inf_text_filesystem_format_write (<em class="parameter"><code><a href="../libinfinity-0.6/InfdFilesystemStorage.html"><span class="type">InfdFilesystemStorage</span></a> *storage</code></em>,
                                  <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                  <em class="parameter"><code><a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> *user_table</code></em>,
                                  <em class="parameter"><code><a class="link" href="InfTextBuffer.html" title="InfTextBuffer"><span class="type">InfTextBuffer</span></a> *buffer</code></em>,
                                  <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Writes the given user table and buffer into the filesystem storage at
<em class="parameter"><code>path</code></em>
. If successful, the session can then be read back with
<a class="link" href="libinftext-0.6-InfTextFilesystemFormat.html#inf-text-filesystem-format-read" title="inf_text_filesystem_format_read ()"><code class="function">inf_text_filesystem_format_read()</code></a>. If the function fails, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is
returned and <em class="parameter"><code>error</code></em>
 is set.</p>
<div class="refsect3">
<a name="id-1.2.15.8.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>storage</p></td>
<td class="parameter_description"><p>A <a href="../libinfinity-0.6/InfdFilesystemStorage.html"><span class="type">InfdFilesystemStorage</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>Storage path where to write the session to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_table</p></td>
<td class="parameter_description"><p>The <a href="../libinfinity-0.6/InfUserTable.html"><span class="type">InfUserTable</span></a> to write.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>The <a class="link" href="InfTextBuffer.html" title="InfTextBuffer"><span class="type">InfTextBuffer</span></a> to write.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.15.8.3.6"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on error.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfTextFilesystemFormatError"></a><h3>enum InfTextFilesystemFormatError</h3>
<p>Errors that can occur when reading a <a class="link" href="libinftext-0.6-inf-text-session.html#InfTextSession"><span class="type">InfTextSession</span></a> from a
<a href="../libinfinity-0.6/InfdFilesystemStorage.html"><span class="type">InfdFilesystemStorage</span></a>.</p>
<div class="refsect3">
<a name="id-1.2.15.9.2.4"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INF-TEXT-FILESYSTEM-FORMAT-ERROR-NOT-A-TEXT-SESSION:CAPS"></a>INF_TEXT_FILESYSTEM_FORMAT_ERROR_NOT_A_TEXT_SESSION</p></td>
<td class="enum_member_description">
<p>The file to be read
is not a serialized text session.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-TEXT-FILESYSTEM-FORMAT-ERROR-USER-EXISTS:CAPS"></a>INF_TEXT_FILESYSTEM_FORMAT_ERROR_USER_EXISTS</p></td>
<td class="enum_member_description">
<p>The user table of the
session contains users with duplicate ID or duplicate name.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INF-TEXT-FILESYSTEM-FORMAT-ERROR-NO-SUCH-USER:CAPS"></a>INF_TEXT_FILESYSTEM_FORMAT_ERROR_NO_SUCH_USER</p></td>
<td class="enum_member_description">
<p>A segment of the text
document is written by a user which does not exist.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libinftext-0.6-InfTextFilesystemFormat.see-also"></a><h2>See Also</h2>
<p><a class="link" href="libinftext-0.6-inf-text-session.html#InfTextSession"><span class="type">InfTextSession</span></a>, <a href="../libinfinity-0.6/InfdFilesystemStorage.html"><span class="type">InfdFilesystemStorage</span></a></p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.21</div>
</body>
</html>