Document the error condition. release-2.x.y

Mon, 21 Jan 2013 18:11:07 -0800

author
Mark Doliner <mark@kingant.net>
date
Mon, 21 Jan 2013 18:11:07 -0800
branch
release-2.x.y
changeset 33655
732c94e8b7ec
parent 33654
cf6979b92221
child 33656
d09413e12a04

Document the error condition.

libpurple/imgstore.h file | annotate | diff | comparison | revisions
--- a/libpurple/imgstore.h	Mon Jan 21 18:09:48 2013 -0800
+++ b/libpurple/imgstore.h	Mon Jan 21 18:11:07 2013 -0800
@@ -91,7 +91,8 @@
  *                  NULL, if you don't need to keep track of a filename.
 
  * @return ID for the image.  This is a unique number that can be used
- *         within libpurple to reference the image.
+ *         within libpurple to reference the image.  0 is returned if the
+ *         image was not added (because of empty data or size).
  */
 int purple_imgstore_add_with_id(gpointer data, size_t size, const char *filename);
 

mercurial