diff src/prpl.h @ 11693:b91a84e7cbcb

[gaim-migrate @ 13979] Don't crash on bonjour when IMing a non-existant user. Also better error reporting, I think. committer: Tailor Script <tailor@pidgin.im>
author Mark Doliner <mark@kingant.net>
date Tue, 18 Oct 2005 04:16:44 +0000
parents 9fc7d0153332
children fa742ad8068c
line wrap: on
line diff
--- a/src/prpl.h	Tue Oct 18 02:54:26 2005 +0000
+++ b/src/prpl.h	Tue Oct 18 04:16:44 2005 +0000
@@ -223,9 +223,20 @@
 
 	/** This must be implemented. */
 	void (*close)(GaimConnection *);
+
+	/**
+	 * This PRPL function should return a positive value on success.
+	 * If the message is too big to be sent, return -E2BIG.  If
+	 * the account is not connected, return -ENOTCONN.  If the
+	 * PRPL is unable to send the message for another reason, return
+	 * some other negative value.  You can use one of the valid
+	 * errno values, or just big something.  If the message should
+	 * not be echoed to the conversation window, return 0.
+	 */
 	int  (*send_im)(GaimConnection *, const char *who,
 					const char *message,
 					GaimConvImFlags flags);
+
 	void (*set_info)(GaimConnection *, const char *info);
 	int  (*send_typing)(GaimConnection *, const char *name, int typing);
 	void (*get_info)(GaimConnection *, const char *who);