From: Kurt Zeilenga <kurt@openldap.org>
Date: Sun, 25 Jun 2000 17:57:47 +0000 (+0000)
Subject: Add comment regarding use of LDAP_OPT_SUCCESS v. LDAP_OPT_ERROR comparisons.
X-Git-Tag: LDBM_PRE_GIANT_RWLOCK~2539
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=6f44bf3ed3cb07950932d0effe107f8771c2f611;p=openldap

Add comment regarding use of LDAP_OPT_SUCCESS v. LDAP_OPT_ERROR comparisons.
---

diff --git a/include/ldap.h b/include/ldap.h
index 7028af91dc..5f27829e67 100644
--- 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)