~ubuntu-branches/ubuntu/utopic/glib2.0/utopic

« back to all changes in this revision

Viewing changes to docs/reference/gio/html/GSeekable.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-10-02 13:08:24 UTC
  • mfrom: (1.67.13)
  • mto: This revision was merged to the branch mainline in revision 233.
  • Revision ID: package-import@ubuntu.com-20141002130824-cqp99rbif2g6wf6r
Tags: upstream-2.42.0
Import upstream version 2.42.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
44
44
<tbody>
45
45
<tr>
46
46
<td class="function_type">
47
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
 
47
<a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
48
48
</td>
49
49
<td class="function_name">
50
50
<a class="link" href="GSeekable.html#g-seekable-tell" title="g_seekable_tell ()">g_seekable_tell</a> <span class="c_punctuation">()</span>
52
52
</tr>
53
53
<tr>
54
54
<td class="function_type">
55
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
55
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
56
56
</td>
57
57
<td class="function_name">
58
58
<a class="link" href="GSeekable.html#g-seekable-can-seek" title="g_seekable_can_seek ()">g_seekable_can_seek</a> <span class="c_punctuation">()</span>
60
60
</tr>
61
61
<tr>
62
62
<td class="function_type">
63
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
63
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
64
64
</td>
65
65
<td class="function_name">
66
66
<a class="link" href="GSeekable.html#g-seekable-seek" title="g_seekable_seek ()">g_seekable_seek</a> <span class="c_punctuation">()</span>
68
68
</tr>
69
69
<tr>
70
70
<td class="function_type">
71
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
71
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
72
72
</td>
73
73
<td class="function_name">
74
74
<a class="link" href="GSeekable.html#g-seekable-can-truncate" title="g_seekable_can_truncate ()">g_seekable_can_truncate</a> <span class="c_punctuation">()</span>
76
76
</tr>
77
77
<tr>
78
78
<td class="function_type">
79
 
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
79
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
80
80
</td>
81
81
<td class="function_name">
82
82
<a class="link" href="GSeekable.html#g-seekable-truncate" title="g_seekable_truncate ()">g_seekable_truncate</a> <span class="c_punctuation">()</span>
106
106
</div>
107
107
<div class="refsect1">
108
108
<a name="GSeekable.object-hierarchy"></a><h2>Object Hierarchy</h2>
109
 
<pre class="screen">    GInterface
 
109
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
110
110
    <span class="lineart">╰──</span> GSeekable
111
111
</pre>
112
112
</div>
114
114
<a name="GSeekable.prerequisites"></a><h2>Prerequisites</h2>
115
115
<p>
116
116
GSeekable requires
117
 
 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
 
117
 <a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>.</p>
118
118
</div>
119
119
<div class="refsect1">
120
120
<a name="GSeekable.implementations"></a><h2>Known Implementations</h2>
145
145
<a name="GSeekable.functions_details"></a><h2>Functions</h2>
146
146
<div class="refsect2">
147
147
<a name="g-seekable-tell"></a><h3>g_seekable_tell ()</h3>
148
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
 
148
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#goffset"><span class="returnvalue">goffset</span></a>
149
149
g_seekable_tell (<em class="parameter"><code><a class="link" href="GSeekable.html" title="GSeekable"><span class="type">GSeekable</span></a> *seekable</code></em>);</pre>
150
150
<p>Tells the current position within the stream.</p>
151
151
<div class="refsect3">
172
172
<hr>
173
173
<div class="refsect2">
174
174
<a name="g-seekable-can-seek"></a><h3>g_seekable_can_seek ()</h3>
175
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
175
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
176
176
g_seekable_can_seek (<em class="parameter"><code><a class="link" href="GSeekable.html" title="GSeekable"><span class="type">GSeekable</span></a> *seekable</code></em>);</pre>
177
177
<p>Tests if the stream supports the <a class="link" href="GSeekable.html#GSeekableIface" title="struct GSeekableIface"><span class="type">GSeekableIface</span></a>.</p>
178
178
<div class="refsect3">
192
192
</div>
193
193
<div class="refsect3">
194
194
<a name="id-1.4.7.2.10.3.6"></a><h4>Returns</h4>
195
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>seekable</code></em>
196
 
can be seeked. <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 
195
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if <em class="parameter"><code>seekable</code></em>
 
196
can be seeked. <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
197
197
<p></p>
198
198
</div>
199
199
</div>
200
200
<hr>
201
201
<div class="refsect2">
202
202
<a name="g-seekable-seek"></a><h3>g_seekable_seek ()</h3>
203
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
203
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
204
204
g_seekable_seek (<em class="parameter"><code><a class="link" href="GSeekable.html" title="GSeekable"><span class="type">GSeekable</span></a> *seekable</code></em>,
205
 
                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> offset</code></em>,
206
 
                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GSeekType"><span class="type">GSeekType</span></a> type</code></em>,
 
205
                 <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> offset</code></em>,
 
206
                 <em class="parameter"><code><a href="../glib/glib-IO-Channels.html#GSeekType"><span class="type">GSeekType</span></a> type</code></em>,
207
207
                 <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
208
 
                 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
208
                 <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
209
209
<p>Seeks in the stream by the given <em class="parameter"><code>offset</code></em>
210
210
, modified by <em class="parameter"><code>type</code></em>
211
211
.</p>
217
217
the end of a fixed-sized stream will fail.</p>
218
218
<p>Any operation that would result in a negative offset will fail.</p>
219
219
<p>If <em class="parameter"><code>cancellable</code></em>
220
 
 is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by
 
220
 is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by
221
221
triggering the cancellable object from another thread. If the operation
222
222
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.</p>
223
223
<div class="refsect3">
236
236
</tr>
237
237
<tr>
238
238
<td class="parameter_name"><p>offset</p></td>
239
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a>.</p></td>
 
239
<td class="parameter_description"><p>a <a href="../glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a>.</p></td>
240
240
<td class="parameter_annotations"> </td>
241
241
</tr>
242
242
<tr>
243
243
<td class="parameter_name"><p>type</p></td>
244
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-IO-Channels.html#GSeekType"><span class="type">GSeekType</span></a>.</p></td>
 
244
<td class="parameter_description"><p>a <a href="../glib/glib-IO-Channels.html#GSeekType"><span class="type">GSeekType</span></a>.</p></td>
245
245
<td class="parameter_annotations"> </td>
246
246
</tr>
247
247
<tr>
248
248
<td class="parameter_name"><p>cancellable</p></td>
249
 
<td class="parameter_description"><p> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
 
249
<td class="parameter_description"><p> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
250
250
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
251
251
</tr>
252
252
<tr>
253
253
<td class="parameter_name"><p>error</p></td>
254
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
 
254
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
255
255
ignore.</p></td>
256
256
<td class="parameter_annotations"> </td>
257
257
</tr>
260
260
</div>
261
261
<div class="refsect3">
262
262
<a name="id-1.4.7.2.10.4.9"></a><h4>Returns</h4>
263
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful. If an error
264
 
has occurred, this function will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em>
 
263
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful. If an error
 
264
has occurred, this function will return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em>
265
265
appropriately if present.</p>
266
266
<p></p>
267
267
</div>
269
269
<hr>
270
270
<div class="refsect2">
271
271
<a name="g-seekable-can-truncate"></a><h3>g_seekable_can_truncate ()</h3>
272
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
272
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
273
273
g_seekable_can_truncate (<em class="parameter"><code><a class="link" href="GSeekable.html" title="GSeekable"><span class="type">GSeekable</span></a> *seekable</code></em>);</pre>
274
274
<p>Tests if the stream can be truncated.</p>
275
275
<div class="refsect3">
289
289
</div>
290
290
<div class="refsect3">
291
291
<a name="id-1.4.7.2.10.5.6"></a><h4>Returns</h4>
292
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stream can be truncated, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
 
292
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the stream can be truncated, <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
293
293
<p></p>
294
294
</div>
295
295
</div>
296
296
<hr>
297
297
<div class="refsect2">
298
298
<a name="g-seekable-truncate"></a><h3>g_seekable_truncate ()</h3>
299
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 
299
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
300
300
g_seekable_truncate (<em class="parameter"><code><a class="link" href="GSeekable.html" title="GSeekable"><span class="type">GSeekable</span></a> *seekable</code></em>,
301
 
                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> offset</code></em>,
 
301
                     <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a> offset</code></em>,
302
302
                     <em class="parameter"><code><a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> *cancellable</code></em>,
303
 
                     <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
 
303
                     <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
304
304
<p>Truncates a stream with a given <span class="type">offset</span>. </p>
305
305
<p>If <em class="parameter"><code>cancellable</code></em>
306
 
 is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by
 
306
 is not <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by
307
307
triggering the cancellable object from another thread. If the operation
308
308
was cancelled, the error <a class="link" href="gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned. If an
309
309
operation was partially finished when the operation was cancelled the
325
325
</tr>
326
326
<tr>
327
327
<td class="parameter_name"><p>offset</p></td>
328
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a>.</p></td>
 
328
<td class="parameter_description"><p>a <a href="../glib/glib-Basic-Types.html#goffset"><span class="type">goffset</span></a>.</p></td>
329
329
<td class="parameter_annotations"> </td>
330
330
</tr>
331
331
<tr>
332
332
<td class="parameter_name"><p>cancellable</p></td>
333
 
<td class="parameter_description"><p> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
 
333
<td class="parameter_description"><p> optional <a class="link" href="GCancellable.html" title="GCancellable"><span class="type">GCancellable</span></a> object, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore. </p></td>
334
334
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
335
335
</tr>
336
336
<tr>
337
337
<td class="parameter_name"><p>error</p></td>
338
 
<td class="parameter_description"><p>a <a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
 
338
<td class="parameter_description"><p>a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> location to store the error occurring, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to
339
339
ignore.</p></td>
340
340
<td class="parameter_annotations"> </td>
341
341
</tr>
344
344
</div>
345
345
<div class="refsect3">
346
346
<a name="id-1.4.7.2.10.6.8"></a><h4>Returns</h4>
347
 
<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful. If an error
348
 
has occurred, this function will return <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em>
 
347
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if successful. If an error
 
348
has occurred, this function will return <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and set <em class="parameter"><code>error</code></em>
349
349
appropriately if present. </p>
350
350
<p></p>
351
351
</div>
395
395
</colgroup>
396
396
<tbody>
397
397
<tr>
398
 
<td class="struct_member_name"><p><a href="http://library.gnome.org/devel/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GSeekableIface.g-iface"></a>g_iface</code></em>;</p></td>
 
398
<td class="struct_member_name"><p><a href="../gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GSeekableIface.g-iface"></a>g_iface</code></em>;</p></td>
399
399
<td class="struct_member_description"><p>The parent interface.</p></td>
400
400
<td class="struct_member_annotations"> </td>
401
401
</tr>