]> git.ipfire.org Git - thirdparty/dovecot/core.git/commitdiff
lib-storage: Comment update to mail_get_stream()
authorTimo Sirainen <tss@iki.fi>
Mon, 25 Oct 2010 17:11:04 +0000 (18:11 +0100)
committerTimo Sirainen <tss@iki.fi>
Mon, 25 Oct 2010 17:11:04 +0000 (18:11 +0100)
src/lib-storage/mail-storage.h

index ee50737d28ab16042db8f48250b6d9fa077cbfad..c4413da423c7f578127ca02cb0bab9a32aed8737 100644 (file)
@@ -658,7 +658,8 @@ int mail_get_header_stream(struct mail *mail,
                           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);