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.
6
ldap_perror, ld_errno, ldap_result2error, ldap_errlist, ldap_err2string \- LDAP protocol error handling routines
8
OpenLDAP LDAP (libldap, -lldap)
15
char *ldap_err2string( int \fIerr\fB );
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.
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).
28
The code associated with an LDAP session is accessible using
29
.BR ldap_get_option (3)
31
.BR ldap_set_option (3)
33
.B LDAP_OPT_RESULT_CODE
34
option (previously called
35
.BR LDAP_OPT_ERROR_NUMBER ).
37
.SH PROTOCOL RESULT CODES
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>.
48
The request was successful.
50
.SM LDAP_OPERATIONS_ERROR
51
An operations error occurred.
53
.SM LDAP_PROTOCOL_ERROR
54
A protocol violation was detected.
56
.SM LDAP_TIMELIMIT_EXCEEDED
57
An LDAP time limit was exceeded.
59
.SM LDAP_SIZELIMIT_EXCEEDED
60
An LDAP size limit was exceeded.
62
.SM LDAP_COMPARE_FALSE
63
A compare operation returned false.
66
A compare operation returned true.
68
.SM LDAP_STRONG_AUTH_NOT_SUPPORTED
69
The LDAP server does not support strong authentication.
71
.SM LDAP_STRONG_AUTH_REQUIRED
72
Strong authentication is required for the operation.
74
.SM LDAP_PARTIAL_RESULTS
75
Partial results only returned.
77
.SM LDAP_NO_SUCH_ATTRIBUTE
78
The attribute type specified does not exist in the entry.
80
.SM LDAP_UNDEFINED_TYPE
81
The attribute type specified is invalid.
83
.SM LDAP_INAPPROPRIATE_MATCHING
84
Filter type not supported for the specified attribute.
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).
90
.SM LDAP_TYPE_OR_VALUE_EXISTS
91
An attribute type or attribute value specified already exists in the entry.
93
.SM LDAP_INVALID_SYNTAX
94
An invalid attribute value was specified.
96
.SM LDAP_NO_SUCH_OBJECT
97
The specified object does not exist in The Directory.
99
.SM LDAP_ALIAS_PROBLEM
100
An alias in The Directory points to a nonexistent entry.
102
.SM LDAP_INVALID_DN_SYNTAX
103
A syntactically invalid DN was specified.
106
The object specified is a leaf.
108
.SM LDAP_ALIAS_DEREF_PROBLEM
109
A problem was encountered when dereferencing an alias.
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).
115
.SM LDAP_INVALID_CREDENTIALS
116
Invalid credentials were presented (e.g., the wrong password).
118
.SM LDAP_INSUFFICIENT_ACCESS
119
The user has insufficient access to perform the operation.
125
The DSA is unavailable.
127
.SM LDAP_UNWILLING_TO_PERFORM
128
The DSA is unwilling to perform the operation.
133
.SM LDAP_NAMING_VIOLATION
134
A naming violation occurred.
136
.SM LDAP_OBJECT_CLASS_VIOLATION
137
An object class violation occurred (e.g., a "must" attribute was missing
140
.SM LDAP_NOT_ALLOWED_ON_NONLEAF
141
The operation is not allowed on a nonleaf object.
143
.SM LDAP_NOT_ALLOWED_ON_RDN
144
The operation is not allowed on an RDN.
146
.SM LDAP_ALREADY_EXISTS
147
The entry already exists.
149
.SM LDAP_NO_OBJECT_CLASS_MODS
150
Object class modifications are not allowed.
153
An unknown error occurred.
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.
166
The LDAP library can't contact the LDAP server.
169
Some local error occurred. This is usually a failed dynamic memory allocation.
171
.SM LDAP_ENCODING_ERROR
172
An error was encountered encoding parameters to send to the LDAP server.
174
.SM LDAP_DECODING_ERROR
175
An error was encountered decoding a result from the LDAP server.
178
A timelimit was exceeded while waiting for a result.
180
.SM LDAP_AUTH_UNKNOWN
181
The authentication method specified to ldap_bind() is not known.
183
.SM LDAP_FILTER_ERROR
184
An invalid filter was supplied to ldap_search() (e.g., unbalanced
188
An ldap routine was called with a bad parameter.
191
An memory allocation (e.g., malloc(3) or other dynamic memory
192
allocator) call failed in an ldap library routine.
194
.SM LDAP_USER_CANCELED
195
Indicates the user cancelled the operation.
197
.SM LDAP_CONNECT_ERROR
198
Indicates a connection problem.
200
.SM LDAP_NOT_SUPPORTED
201
Indicates the routine was called in a manner not supported by the library.
203
.SM LDAP_CONTROL_NOT_FOUND
204
Indicates the control provided is unknown to the client library.
206
.SM LDAP_NO_RESULTS_RETURNED
207
Indicates no results returned.
209
.SM LDAP_MORE_RESULTS_TO_RETURN
210
Indicates more results could be returned.
213
Indicates the library has detected a loop in its processing.
215
.SM LDAP_REFERRAL_LIMIT_EXCEEDED
216
Indicates the referral limit has been exceeded.
added
removed
doc/man/man3/ldap_error.3
