diff options
author | Carl Worth <cworth@cworth.org> | 2009-10-23 15:12:03 -0700 |
---|---|---|
committer | Carl Worth <cworth@cworth.org> | 2009-10-23 15:12:03 -0700 |
commit | 03c40c2bb04a762539e5fbc9924a1ce1e5548cc8 (patch) | |
tree | 4f201cb10d969c2674fd04d0e2baa4c2e305cb80 /notmuch.h | |
parent | fb1bae07002d45138832eacb280419dbd7a19774 (diff) |
notmuch_message_get_filename: Improve documentation.
Fix a typo, and add clarifications about the lifetime and readonly
nature of the return value.
Diffstat (limited to 'notmuch.h')
-rw-r--r-- | notmuch.h | 7 |
1 files changed, 5 insertions, 2 deletions
@@ -408,10 +408,13 @@ notmuch_results_destroy (notmuch_results_t *results); const char * notmuch_message_get_message_id (notmuch_message_t *message); -/* Get this filename for the email corresponding to 'message'. +/* Get the filename for the email corresponding to 'message'. * * The returned filename is relative to the base of the database from - * which 'message' was obtained. See notmuch_database_get_path() .*/ + * which 'message' was obtained. See notmuch_database_get_path() . + * The returned string belongs to the message so should not be + * modified or freed by the caller (nor should it be referenced after + * the message is destroyed). */ const char * notmuch_message_get_filename (notmuch_message_t *message); |