aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-seekable-stream.c
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2000-04-29 23:57:11 +0800
committerDan Winship <danw@src.gnome.org>2000-04-29 23:57:11 +0800
commit18903e6b226aa9f18e1fd25450b2b463dd2a4801 (patch)
treefa0d21c0756de5c6decca25d8608516fba59bd16 /camel/camel-seekable-stream.c
parent4e9fab3ba3a1b55ef924ae4332bf43e7fc3d12ba (diff)
downloadgsoc2013-evolution-18903e6b226aa9f18e1fd25450b2b463dd2a4801.tar.gz
gsoc2013-evolution-18903e6b226aa9f18e1fd25450b2b463dd2a4801.tar.zst
gsoc2013-evolution-18903e6b226aa9f18e1fd25450b2b463dd2a4801.zip
camel_mime_parser_tell() returns an offset from where it started parsing,
* camel-mime-part-utils.c (simple_data_wrapper_construct_from_parser): camel_mime_parser_tell() returns an offset from where it started parsing, not necessarily from the start of data. Since we're parsing a bounded seekable_stream, we need to add the stream's starting bound to camel_mime_parser_tell's return value to create the substream in the right place. * camel-seekable-substream.c (camel_seekable_substream_new_with_seekable_stream_and_bounds): say CAMEL_STREAM_UNBOUND rather than -1 in doc. * camel-seekable-stream.c (camel_seekable_stream_seek): Add more info to docs. svn path=/trunk/; revision=2680
Diffstat (limited to 'camel/camel-seekable-stream.c')
-rw-r--r--camel/camel-seekable-stream.c13
1 files changed, 12 insertions, 1 deletions
diff --git a/camel/camel-seekable-stream.c b/camel/camel-seekable-stream.c
index 27eba97d26..6d51c6c554 100644
--- a/camel/camel-seekable-stream.c
+++ b/camel/camel-seekable-stream.c
@@ -106,7 +106,18 @@ seek (CamelSeekableStream *stream,
* @offset: offset value
* @policy: what to do with the offset
*
- *
+ * Seek to the specified position in @stream.
+ *
+ * If @policy is CAMEL_STREAM_SET, seeks to @offset.
+ *
+ * If @policy is CAMEL_STREAM_CUR, seeks to the current position plus
+ * @offset.
+ *
+ * If @policy is CAMEL_STREAM_END, seeks to the end of the stream plus
+ * @offset.
+ *
+ * Regardless of @policy, the stream's final position will be clamped
+ * to the range specified by its lower and upper bounds.
*
* Return value: new position, -1 if operation failed.
**/