external/bsd/openldap/dist/doc/man/man3/ldap_error.3

   1 .TH LDAP_ERROR 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_error.3,v 1.21.2.4 2008/02/11 23:26:39 kurt Exp $
   3 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_perror, ld_errno, ldap_result2error, ldap_errlist, ldap_err2string \- LDAP protocol error handling routines
   7 .SH LIBRARY
   8 OpenLDAP LDAP (libldap, -lldap)
   9 .SH SYNOPSIS
  10 .nf
  11 .ft B
  12 #include <ldap.h>
  13 .LP
  14 .ft B
  15 char *ldap_err2string( int \fIerr\fB );
  16 .SH DESCRIPTION
  17 The
  18 .B ldap_err2string()
  19 routine provides short description of the various codes returned by
  20 routines in this library.  The returned string is a pointer to a
  21 static area that should not be modified.
  22
  23 These codes are either negative,
  24 indicating an API error code; positive, indicating an LDAP resultCode
  25 other than \'success' (0), or - zero, indicating both successful use
  26 of the API and the LDAP resultCode \'success' (0).
  27
  28 The code associated with an LDAP session is accessible using
  29 .BR ldap_get_option (3)
  30 and
  31 .BR ldap_set_option (3)
  32 with the
  33 .B LDAP_OPT_RESULT_CODE
  34 option (previously called
  35 .BR LDAP_OPT_ERROR_NUMBER ).
  36
  37 .SH PROTOCOL RESULT CODES
  38
  39 This section provides a partial list of protocol codes recognized
  40 by the library.  As LDAP is extensible, additional values may be
  41 returned.  A complete listing of \fIregistered\fP LDAP result codes
  42 can be obtained from the \fIInternet Assigned Numbers Authority\fP
  43 <http://www.iana.org>.
  44
  45 .LP
  46 .TP 20
  47 .SM LDAP_SUCCESS
  48 The request was successful.
  49 .TP
  50 .SM LDAP_OPERATIONS_ERROR
  51 An operations error occurred.
  52 .TP
  53 .SM LDAP_PROTOCOL_ERROR
  54 A protocol violation was detected.
  55 .TP
  56 .SM LDAP_TIMELIMIT_EXCEEDED
  57 An LDAP time limit was exceeded.
  58 .TP
  59 .SM LDAP_SIZELIMIT_EXCEEDED
  60 An LDAP size limit was exceeded.
  61 .TP
  62 .SM LDAP_COMPARE_FALSE
  63 A compare operation returned false.
  64 .TP
  65 .SM LDAP_COMPARE_TRUE
  66 A compare operation returned true.
  67 .TP
  68 .SM LDAP_STRONG_AUTH_NOT_SUPPORTED
  69 The LDAP server does not support strong authentication.
  70 .TP
  71 .SM LDAP_STRONG_AUTH_REQUIRED
  72 Strong authentication is required for the operation.
  73 .TP
  74 .SM LDAP_PARTIAL_RESULTS
  75 Partial results only returned.
  76 .TP
  77 .SM LDAP_NO_SUCH_ATTRIBUTE
  78 The attribute type specified does not exist in the entry.
  79 .TP
  80 .SM LDAP_UNDEFINED_TYPE
  81 The attribute type specified is invalid.
  82 .TP
  83 .SM LDAP_INAPPROPRIATE_MATCHING
  84 Filter type not supported for the specified attribute.
  85 .TP
  86 .SM LDAP_CONSTRAINT_VIOLATION
  87 An attribute value specified violates some constraint (e.g., a postalAddress
  88 has too many lines, or a line that is too long).
  89 .TP
  90 .SM LDAP_TYPE_OR_VALUE_EXISTS
  91 An attribute type or attribute value specified already exists in the entry.
  92 .TP
  93 .SM LDAP_INVALID_SYNTAX
  94 An invalid attribute value was specified.
  95 .TP
  96 .SM LDAP_NO_SUCH_OBJECT
  97 The specified object does not exist in The Directory.
  98 .TP
  99 .SM LDAP_ALIAS_PROBLEM
 100 An alias in The Directory points to a nonexistent entry.
 101 .TP
 102 .SM LDAP_INVALID_DN_SYNTAX
 103 A syntactically invalid DN was specified.
 104 .TP
 105 .SM LDAP_IS_LEAF
 106 The object specified is a leaf.
 107 .TP
 108 .SM LDAP_ALIAS_DEREF_PROBLEM
 109 A problem was encountered when dereferencing an alias.
 110 .TP
 111 .SM LDAP_INAPPROPRIATE_AUTH
 112 Inappropriate authentication was specified (e.g., LDAP_AUTH_SIMPLE was
 113 specified and the entry does not have a userPassword attribute).
 114 .TP
 115 .SM LDAP_INVALID_CREDENTIALS
 116 Invalid credentials were presented (e.g., the wrong password).
 117 .TP
 118 .SM LDAP_INSUFFICIENT_ACCESS
 119 The user has insufficient access to perform the operation.
 120 .TP
 121 .SM LDAP_BUSY
 122 The DSA is busy.
 123 .TP
 124 .SM LDAP_UNAVAILABLE
 125 The DSA is unavailable.
 126 .TP
 127 .SM LDAP_UNWILLING_TO_PERFORM
 128 The DSA is unwilling to perform the operation.
 129 .TP
 130 .SM LDAP_LOOP_DETECT
 131 A loop was detected.
 132 .TP
 133 .SM LDAP_NAMING_VIOLATION
 134 A naming violation occurred.
 135 .TP
 136 .SM LDAP_OBJECT_CLASS_VIOLATION
 137 An object class violation occurred (e.g., a "must" attribute was missing
 138 from the entry).
 139 .TP
 140 .SM LDAP_NOT_ALLOWED_ON_NONLEAF
 141 The operation is not allowed on a nonleaf object.
 142 .TP
 143 .SM LDAP_NOT_ALLOWED_ON_RDN
 144 The operation is not allowed on an RDN.
 145 .TP
 146 .SM LDAP_ALREADY_EXISTS
 147 The entry already exists.
 148 .TP
 149 .SM LDAP_NO_OBJECT_CLASS_MODS
 150 Object class modifications are not allowed.
 151 .TP
 152 .SM LDAP_OTHER
 153 An unknown error occurred.
 154
 155 .SH API ERROR CODES
 156
 157 This section provides a complete list of API error codes recognized
 158 by the library.   Note that LDAP_SUCCESS indicates success of an
 159 API call in addition to representing the return of the LDAP
 160 \'success' resultCode.
 161
 162
 163 .LP
 164 .TP 20
 165 .SM LDAP_SERVER_DOWN
 166 The LDAP library can't contact the LDAP server.
 167 .TP
 168 .SM LDAP_LOCAL_ERROR
 169 Some local error occurred.  This is usually a failed dynamic memory allocation.
 170 .TP
 171 .SM LDAP_ENCODING_ERROR
 172 An error was encountered encoding parameters to send to the LDAP server.
 173 .TP
 174 .SM LDAP_DECODING_ERROR
 175 An error was encountered decoding a result from the LDAP server.
 176 .TP
 177 .SM LDAP_TIMEOUT
 178 A timelimit was exceeded while waiting for a result.
 179 .TP
 180 .SM LDAP_AUTH_UNKNOWN
 181 The authentication method specified to ldap_bind() is not known.
 182 .TP
 183 .SM LDAP_FILTER_ERROR
 184 An invalid filter was supplied to ldap_search() (e.g., unbalanced
 185 parentheses).
 186 .TP
 187 .SM LDAP_PARAM_ERROR
 188 An ldap routine was called with a bad parameter.
 189 .TP
 190 .SM LDAP_NO_MEMORY
 191 An memory allocation (e.g., malloc(3) or other dynamic memory
 192 allocator) call failed in an ldap library routine.
 193 .TP
 194 .SM LDAP_USER_CANCELED
 195 Indicates the user cancelled the operation.
 196 .TP
 197 .SM LDAP_CONNECT_ERROR
 198 Indicates a connection problem.
 199 .TP
 200 .SM LDAP_NOT_SUPPORTED
 201 Indicates the routine was called in a manner not supported by the library.
 202 .TP
 203 .SM LDAP_CONTROL_NOT_FOUND
 204 Indicates the control provided is unknown to the client library.
 205 .TP
 206 .SM LDAP_NO_RESULTS_RETURNED
 207 Indicates no results returned.
 208 .TP
 209 .SM LDAP_MORE_RESULTS_TO_RETURN
 210 Indicates more results could be returned.
 211 .TP
 212 .SM LDAP_CLIENT_LOOP
 213 Indicates the library has detected a loop in its processing.
 214 .TP
 215 .SM LDAP_REFERRAL_LIMIT_EXCEEDED
 216 Indicates the referral limit has been exceeded.
 217
 218 .SH DEPRECATED
 219 .so Deprecated
 220
 221 .SH SEE ALSO
 222 .BR ldap (3),
 223 .SH ACKNOWLEDGEMENTS
 224 .so ../Project