changeset 12350:1b2caff94b49

lib-storage: Comment update to mail_get_stream()
author Timo Sirainen <tss@iki.fi>
date Mon, 25 Oct 2010 18:11:04 +0100
parents d1fd5b84d410
children d46a3fca7259
files src/lib-storage/mail-storage.h
diffstat 1 files changed, 2 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/lib-storage/mail-storage.h	Mon Oct 25 17:34:10 2010 +0100
+++ b/src/lib-storage/mail-storage.h	Mon Oct 25 18:11:04 2010 +0100
@@ -658,7 +658,8 @@
 			   struct mailbox_header_lookup_ctx *headers,
 			   struct istream **stream_r);
 /* Returns input stream pointing to beginning of message header.
-   hdr_size and body_size are updated unless they're NULL. */
+   hdr_size and body_size are updated unless they're NULL. The returned stream
+   is destroyed automatically, don't unreference it. */
 int mail_get_stream(struct mail *mail, struct message_size *hdr_size,
 		    struct message_size *body_size, struct istream **stream_r);