]> git.sur5r.net Git - openldap/blobdiff - include/ldap.h
Change API error codes to negative numbers so as not to clash
[openldap] / include / ldap.h
index cf96aa7f9818de4e967bd566fe5698ae5586e728..67310c9c01db499fa2cea5939e270470ce66540c 100644 (file)
@@ -1,16 +1,18 @@
 /* $OpenLDAP$ */
-/*
- * Copyright 1998-2003 The OpenLDAP Foundation, Redwood City, California, USA
+/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
+ * 
+ * Copyright 1998-2003 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted only as authorized by the OpenLDAP
- * Public License.  A copy of this license is available at
- * http://www.OpenLDAP.org/license.html or in file LICENSE in the
- * top-level directory of the distribution.
+ * Public License.
+ *
+ * A copy of this license is available in file LICENSE in the
+ * top-level directory of the distribution or, alternatively, at
+ * <http://www.OpenLDAP.org/license.html>.
  */
-/* Portions
- * Copyright (c) 1990 Regents of the University of Michigan.
+/* Portions Copyright (c) 1990 Regents of the University of Michigan.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms are permitted
@@ -64,6 +66,7 @@ LDAP_BEGIN_DECL
 /* #define LDAP_API_OPERATION_SESSION_SAFE     1       */
 #endif
 
+
 #define LDAP_PORT              389             /* ldap:///             default LDAP port */
 #define LDAPS_PORT             636             /* ldaps:///    default LDAP over TLS port */
 
@@ -206,23 +209,27 @@ typedef struct ldapcontrol {
 #define LDAP_CONTROL_SYNC_DONE "1.3.6.1.4.1.4203.666.5.8"
 #define LDAP_SYNC_INFO                 "1.3.6.1.4.1.4203.666.10.2"
 
-#define LDAP_SYNC_REFRESH_PRESENTS     0
-#define LDAP_SYNC_REFRESH_DELETES   1
+#define LDAP_SYNC_NONE                                 0x00
+#define LDAP_SYNC_REFRESH_ONLY                 0x01
+#define LDAP_SYNC_REFRESH_AND_PERSIST  0x03
+
+#define LDAP_SYNC_REFRESH_PRESENTS             0
+#define LDAP_SYNC_REFRESH_DELETES              1
 
 #define LDAP_TAG_SYNC_NEW_COOKIE               ((ber_tag_t) 0x80U)
 #define LDAP_TAG_SYNC_REFRESH_DELETE   ((ber_tag_t) 0xa1U)
 #define LDAP_TAG_SYNC_REFRESH_PRESENT  ((ber_tag_t) 0xa2U)
 #define        LDAP_TAG_SYNC_ID_SET                    ((ber_tag_t) 0xa3U)
 
-#define LDAP_TAG_SYNC_COOKIE   ((ber_tag_t) 0x04U)
-#define LDAP_TAG_REFRESHDELETES        ((ber_tag_t) 0x01U)
-#define LDAP_TAG_REFRESHDONE   ((ber_tag_t) 0x01U)
-#define LDAP_TAG_RELOAD_HINT   ((ber_tag_t) 0x01U)
+#define LDAP_TAG_SYNC_COOKIE                   ((ber_tag_t) 0x04U)
+#define LDAP_TAG_REFRESHDELETES                        ((ber_tag_t) 0x01U)
+#define LDAP_TAG_REFRESHDONE                   ((ber_tag_t) 0x01U)
+#define LDAP_TAG_RELOAD_HINT                   ((ber_tag_t) 0x01U)
 
-#define LDAP_SYNC_PRESENT              0
-#define LDAP_SYNC_ADD                  1
-#define LDAP_SYNC_MODIFY               2
-#define LDAP_SYNC_DELETE               3
+#define LDAP_SYNC_PRESENT                              0
+#define LDAP_SYNC_ADD                                  1
+#define LDAP_SYNC_MODIFY                               2
+#define LDAP_SYNC_DELETE                               3
 
 #define LDAP_CONTROL_SORTREQUEST    "1.2.840.113556.1.4.473"
 #define LDAP_CONTROL_SORTRESPONSE      "1.2.840.113556.1.4.474"
@@ -446,30 +453,7 @@ typedef struct ldapcontrol {
 
 #define LDAP_OTHER                             0x50
 
-#define LDAP_API_ERROR(n)              LDAP_RANGE((n),0x51,0x61) /* 81-97 */
-#define LDAP_API_RESULT(n)             (((n) == LDAP_SUCCESS) || \
-                                                               LDAP_RANGE((n),0x51,0x61)) /* 0,81-97 */
-
-/* reserved for APIs */
-#define LDAP_SERVER_DOWN               0x51
-#define LDAP_LOCAL_ERROR               0x52
-#define LDAP_ENCODING_ERROR            0x53
-#define LDAP_DECODING_ERROR            0x54
-#define LDAP_TIMEOUT                   0x55
-#define LDAP_AUTH_UNKNOWN              0x56
-#define LDAP_FILTER_ERROR              0x57
-#define LDAP_USER_CANCELLED            0x58
-#define LDAP_PARAM_ERROR               0x59
-#define LDAP_NO_MEMORY                 0x5a
-
-/* used but not reserved for APIs */
-#define LDAP_CONNECT_ERROR                             0x5b    /* draft-ietf-ldap-c-api-xx */
-#define LDAP_NOT_SUPPORTED                             0x5c    /* draft-ietf-ldap-c-api-xx */
-#define LDAP_CONTROL_NOT_FOUND                 0x5d    /* draft-ietf-ldap-c-api-xx */
-#define LDAP_NO_RESULTS_RETURNED               0x5e    /* draft-ietf-ldap-c-api-xx */
-#define LDAP_MORE_RESULTS_TO_RETURN            0x5f    /* draft-ietf-ldap-c-api-xx */
-#define LDAP_CLIENT_LOOP                               0x60    /* draft-ietf-ldap-c-api-xx */
-#define LDAP_REFERRAL_LIMIT_EXCEEDED   0x61    /* draft-ietf-ldap-c-api-xx */
+/* Expermental result codes -- subject to change */
 
 #define LDAP_SYNC_RESOURCES_EXHAUSTED  0x100
 #define LDAP_SYNC_SECURITY_VIOLATION   0x101
@@ -480,18 +464,38 @@ typedef struct ldapcontrol {
 
 #define LDAP_ASSERTION_FAILED                  0x10f
 
-#ifdef LDAP_EXOP_X_CANCEL
 /* resultCode for Cancel Response */
 #define LDAP_CANCELLED                                 0x110
 #define LDAP_NO_SUCH_OPERATION                 0x111
 #define LDAP_TOO_LATE                                  0x112
 #define LDAP_CANNOT_CANCEL                             0x113
-#endif
 
-/* LDAP SYNC request type */
-#define LDAP_SYNC_NONE                                 0x00
-#define LDAP_SYNC_REFRESH_ONLY                 0x01
-#define LDAP_SYNC_REFRESH_AND_PERSIST  0x03
+#define LDAP_API_ERROR(n)              ((n)<0)
+#define LDAP_API_RESULT(n)             ((n)<=0)
+
+/* API Error Codes
+ *
+ * Based on draft-ietf-ldap-c-api-xx
+ * but with new (negative) codes
+ */
+#define LDAP_SERVER_DOWN               (-1)
+#define LDAP_LOCAL_ERROR               (-2)
+#define LDAP_ENCODING_ERROR            (-3)
+#define LDAP_DECODING_ERROR            (-4)
+#define LDAP_TIMEOUT                   (-5)
+#define LDAP_AUTH_UNKNOWN              (-6)
+#define LDAP_FILTER_ERROR              (-7)
+#define LDAP_USER_CANCELLED            (-8)
+#define LDAP_PARAM_ERROR               (-9)
+#define LDAP_NO_MEMORY                 (-10)
+#define LDAP_CONNECT_ERROR                             (-11)
+#define LDAP_NOT_SUPPORTED                             (-12)
+#define LDAP_CONTROL_NOT_FOUND                 (-13)
+#define LDAP_NO_RESULTS_RETURNED               (-14)
+#define LDAP_MORE_RESULTS_TO_RETURN            (-15)
+#define LDAP_CLIENT_LOOP                               (-16)
+#define LDAP_REFERRAL_LIMIT_EXCEEDED   (-17)
+
 
 /*
  * This structure represents both ldap messages and ldap responses.
@@ -1523,8 +1527,7 @@ ldap_mods_free LDAP_P((
 
 
 /*
- * in sort.c
- *     (deprecated)
+ * in sort.c (deprecated)
  */
 typedef int (LDAP_SORT_AD_CMP_PROC) LDAP_P(( /* deprecated */
        LDAP_CONST char *left,
@@ -1551,7 +1554,6 @@ ldap_sort_strcasecmp LDAP_P((
        LDAP_CONST void *a,
        LDAP_CONST void *b ));
 
-
 /*
  * in url.c
  */
@@ -1580,12 +1582,14 @@ LDAP_F( void )
 ldap_free_urldesc LDAP_P((
        LDAPURLDesc *ludp ));
 
+
 /*
- * in sortctrl.c
- */
-/*
- * structure for a sort-key
+ * LDAP Server Side Sort
+ *     in sortctrl.c
  */
+#define LDAP_API_FEATURE_SERVER_SIDE_SORT 1000
+
+/* structure for a sort-key */
 typedef struct ldapsortkey {
        char *  attributeType;
        char *  orderingRule;
@@ -1617,21 +1621,21 @@ ldap_parse_sort_control LDAP_P((
 
 
 /*
- * in vlvctrl.c
+ * LDAP Virtual List View
+ *     in vlvctrl.c
  */
+#define LDAP_API_FEATURE_VIRTUAL_LIST_VIEW 1000
 
-/*
- * structure for virtual list.
- */
+/* structure for virtual list */
 typedef struct ldapvlvinfo {
        int             ldvlv_version;
     unsigned long   ldvlv_before_count;
     unsigned long   ldvlv_after_count;
     unsigned long   ldvlv_offset;
     unsigned long   ldvlv_count;
-    struct berval  *ldvlv_attrvalue;
-    struct berval  *ldvlv_context;
-    void           *ldvlv_extradata;
+    struct berval *    ldvlv_attrvalue;
+    struct berval *    ldvlv_context;
+    void *                     ldvlv_extradata;
 } LDAPVLVInfo;
 
 LDAP_F( int )
@@ -1650,7 +1654,8 @@ ldap_parse_vlv_control LDAP_P((
        int           *errcodep ));
 
 /*
- * LDAP Who Am I? (whoami.c)
+ * LDAP Who Am I?
+ *     in whoami.c
  */
 
 LDAP_F( int )
@@ -1673,7 +1678,8 @@ ldap_whoami_s LDAP_P((
        LDAPControl **cctrls ));
 
 /*
- * in passwd.c
+ * LDAP Password Modify
+ *     in passwd.c
  */
 
 LDAP_F( int )
@@ -1701,5 +1707,6 @@ ldap_passwd_s LDAP_P((
        LDAPControl **sctrls,
        LDAPControl **cctrls ));
 
+
 LDAP_END_DECL
 #endif /* _LDAP_H */