Add comment regarding use of LDAP_OPT_SUCCESS v. LDAP_OPT_ERROR comparisons.

diff --git a/include/ldap.h b/include/ldap.h
index 7028af91dc5e3fa1124cacc1c50b302b5da00582..5f27829e67fa73f52bdd81a870f217a12da7d3f9 100644 (file)
--- a/include/ldap.h
+++ b/include/ldap.h
@@ -138,6 +138,12 @@ LDAP_BEGIN_DECL
 #define LDAP_OPT_ON            ((void *) 1)
 #define LDAP_OPT_OFF   ((void *) 0)
 
+/*
+ * ldap_get_option() and ldap_set_option() return values.
+ * As later versions may return other values indicating
+ * failure, current applications should only compare returned
+ * value against LDAP_OPT_SUCCESS.
+ */
 #define LDAP_OPT_SUCCESS       0
 #define        LDAP_OPT_ERROR          (-1)