summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulien Danjou <julien@danjou.info>2008-09-19 08:13:23 +0200
committerJulien Danjou <julien@danjou.info>2008-09-19 08:13:23 +0200
commita6ca9f24302f95a76fc77d0d8e4a0eea15fdb501 (patch)
treed3fc63350dc7ddc972f07bf4a88fbaf1e3f9e169
parent85f200ad455d8ac90e04b8d2a9b6e7ae948abe5e (diff)
icccm: add some comment on text reply usage
Signed-off-by: Julien Danjou <julien@danjou.info>
-rw-r--r--icccm/xcb_icccm.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/icccm/xcb_icccm.h b/icccm/xcb_icccm.h
index 1514adb..fb0ef6f 100644
--- a/icccm/xcb_icccm.h
+++ b/icccm/xcb_icccm.h
@@ -92,6 +92,9 @@ xcb_get_property_cookie_t xcb_get_text_property_unchecked(xcb_connection_t *c,
* @param e Error if any.
* @return Return 1 on success, 0 otherwise.
*
+ * If the function return 0 (failure), the content of prop is unmodified and
+ * therefore the structure must not be wiped.
+ *
* The parameter e supplied to this function must be NULL if
* xcb_get_text_property_unchecked() is used. Otherwise, it stores
* the error if any. prop structure members should be freed by