summaryrefslogtreecommitdiff
path: root/libpurple/account.h
diff options
context:
space:
mode:
authorWill Thompson <resiak@pidgin.im>2007-10-30 21:38:14 +0000
committerWill Thompson <resiak@pidgin.im>2007-10-30 21:38:14 +0000
commit421bf76113082d5ba99e8f2d9e33d9da20f4308d (patch)
treedaea20bcccc7d8fabe8df3fca083a34531e2316c /libpurple/account.h
parentbb7b9984e6f0b23a5c13cb5f5dc098d74c50a262 (diff)
downloadpidgin-421bf76113082d5ba99e8f2d9e33d9da20f4308d.tar.gz
Document exactly how long the PurpleConnectionErrorInfo pointers given out by
account-error-changed and purple_account_get_current_error() are valid.
Diffstat (limited to 'libpurple/account.h')
-rw-r--r--libpurple/account.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/libpurple/account.h b/libpurple/account.h
index df9f10f9ca..b6146b59aa 100644
--- a/libpurple/account.h
+++ b/libpurple/account.h
@@ -901,7 +901,9 @@ gboolean purple_account_supports_offline_message(PurpleAccount *account, PurpleB
*
* @param account The account whose error should be retrieved.
* @constreturn The type of error and a human-readable description of the
- * current error, or @c NULL if there is no current error.
+ * current error, or @c NULL if there is no current error. This
+ * pointer is guaranteed to remain valid until the @ref
+ * account-error-changed signal is emitted for @a account.
*/
const PurpleConnectionErrorInfo *purple_account_get_current_error(PurpleAccount *account);