LDAPEROR(3) LDAPEROR(3)
NAME
ldapperror, lderrno, ldapresult2error, ldaperrlist, ldaperr2string
- LDAP protocol error handling routines
LIBRARY
OpenLDAP LDAP (libldap, -lldap)
SYNOPSIS
##include <>
char **ldaperr2string( int err );;
void ldapperror( LDAP **ld,, const char **s )
int ldapresult2error( LDAP **ld,, LDAPessage **res,, int freeit )
DESCRIPTION
These routines provide interpretation of the various error codes
returned by the LDAP protocol and LDAP library routines or associated
with an LDAP session. The error code associated with an LDAP session
is accessible using ldapgetoption(3) and ldapsetoption(3) with the
LDAPOPTRESULTCODE option (previously called LDAPOPTERORNUMBER).
The ldapresult2error() routine takes res, a result as produced by
ldapresult(3) or ldapsearchs(3), and returns the corresponding error
code. Possible error codes are listed below. If the freeit parameter
is non zero it indicates that the res parameter should be freed by a
call to ldapmsgfree(3) after the error code has been extracted. The
lderrno field in ld is set and returned.
The returned value can be passed to ldaperr2string() to get a text
description of the message. The string returned from ldaperr2string()
is a pointer to a static area that should not be modified.
The ldapperror() routine can be called to print an indication of the
error on standard error, similar to the way perror(3) works.
ERORS
The possible values for an ldap error code are:
LDAPSUCES The request was successful.
LDAPOPERATIONSEROR
An operations error occurred.
LDAPROTOCOLEROR A protocol violation was detected.
LDAPTIMELIMITEXCEDED
An LDAP time limit was exceeded.
LDAPSIZELIMITEXCEDED
An LDAP size limit was exceeded.
LDAPCOMPAREFALSE A compare operation returned false.
LDAPCOMPARETRUE A compare operation returned true.
LDAPSTRONGAUTHNOTSUPORTED
The LDAP server does not support strong authentica-
tion.
LDAPSTRONGAUTHREQUIRED
Strong authentication is required for the opera-
tion.
LDAPARTIALRESULTS
Partial results only returned.
LDAPNOSUCHATRIBUTE
The attribute type specified does not exist in the
entry.
LDAPUNDEFINEDTYPE The attribute type specified is invalid.
LDAPINAPROPRIATEMATCHING
Filter type not supported for the specified
attribute.
LDAPCONSTRAINTVIOLATION
An attribute value specified violates some con-
straint (e.g., a postalAddress has too many lines,
or a line that is too long).
LDAPTYPEORVALUEXISTS
An attribute type or attribute value specified
already exists in the entry.
LDAPINVALIDSYNTAX An invalid attribute value was specified.
LDAPNOSUCHOBJECT The specified object does not exist in The Direc-
tory.
LDAPALIASPROBLEM An alias in The Directory points to a nonexistent
entry.
LDAPINVALIDNSYNTAX
A syntactically invalid DN was specified.
LDAPISLEAF The object specified is a leaf.
LDAPALIASDEREFPROBLEM
A problem was encountered when dereferencing an
alias.
LDAPINAPROPRIATEAUTH
Inappropriate authentication was specified (e.g.,
LDAPAUTHSIMPLE was specified and the entry does
not have a userPassword attribute).
LDAPINVALIDCREDENTIALS
Invalid credentials were presented (e.g., the wrong
password).
LDAPINSUFICIENTACES
The user has insufficient access to perform the
operation.
LDAPBUSY The DSA is busy.
LDAPUNAVAILABLE The DSA is unavailable.
LDAPUNWILINGTOPERFORM
The DSA is unwilling to perform the operation.
LDAPLOPDETECT A loop was detected.
LDAPNAMINGVIOLATION
A naming violation occurred.
LDAPOBJECTCLASVIOLATION
An object class violation occurred (e.g., a "must"
attribute was missing from the entry).
LDAPNOTALOWEDONONLEAF
The operation is not allowed on a nonleaf object.
LDAPNOTALOWEDONRDN
The operation is not allowed on an RDN.
LDAPALREADYEXISTS The entry already exists.
LDAPNOBJECTCLASMODS
Object class modifications are not allowed.
LDAPOTHER An unknown error occurred.
LDAPSERVERDOWN The LDAP library can't contact the LDAP server.
LDAPLOCALEROR Some local error occurred. This is usually a
failed dynamic memory allocation.
LDAPENCODINGEROR An error was encountered encoding parameters to
send to the LDAP server.
LDAPDECODINGEROR An error was encountered decoding a result from the
LDAP server.
LDAPTIMEOUT A timelimit was exceeded while waiting for a
result.
LDAPAUTHUNKNOWN The authentication method specified to ldapbind()
is not known.
LDAPFILTEREROR An invalid filter was supplied to ldapsearch()
(e.g., unbalanced parentheses).
LDAPARAMEROR An ldap routine was called with a bad parameter.
LDAPNOMEMORY An memory allocation (e.g., malloc(3) or other
dynamic memory allocator) call failed in an ldap
library routine.
SEE ALSO
ldap(3), perror(3)
ACKNOWLEDGEMENTS
OpenLDAP is developed and maintained by The OpenLDAP Project
(http:/www.openldap.org/). OpenLDAP is derived from University of
Michigan LDAP 3.3 Release.
OpenLDAP 2.2.19 2004/11/26 LDAPEROR(3)
|
