summaryrefslogtreecommitdiff
path: root/libpurple/account.h
diff options
context:
space:
mode:
authorWill Thompson <will.thompson@collabora.co.uk>2007-10-30 21:38:14 (GMT)
committerWill Thompson <will.thompson@collabora.co.uk>2007-10-30 21:38:14 (GMT)
commit997017031683c4169b471eee0ba55726387b7a5e (patch)
treed95ce517a96d75a33a89e1664cc291e93f27baff /libpurple/account.h
parentf12751cfb6b86ddac1f7b166d997a606eeda099b (diff)
downloadpidgin-997017031683c4169b471eee0ba55726387b7a5e.tar.gz
pidgin-997017031683c4169b471eee0ba55726387b7a5e.tar.xz
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 df9f10f..b6146b5 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);