stta/stta/perl-ldap-0.26/blib/man3/Net::LDAP::Constant.3pm

.\" Automatically generated by Pod::Man version 1.15
.\" Fri Oct  4 06:36:43 2002
.\"
.\" Standard preamble:
.\" ======================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R

.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
.\" index entries marked with X<> in POD.  Of course, you'll have to process
.\" the output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it
.\" makes way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.bd B 3
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ======================================================================
.\"
.IX Title "CONSTANT 1"
.TH CONSTANT 1 "perl v5.6.1" "2001-08-24" "User Contributed Perl Documentation"
.UC
.SH "NAME"
Net::LDAP::Constant \- Constants for use with Net::LDAP
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Net::LDAP qw(LDAP_SUCCESS LDAP_PROTOCOL_ERROR);
.Ve
.Vb 2
\& # import all constants 
\& use Net::LDAP qw(:all);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBNet::LDAP::Constant\fR exports constant subroutines for the following \s-1LDAP\s0
error codes.
.Ip "\s-1LDAP_SUCCESS\s0" 4
.IX Item "LDAP_SUCCESS"
Operation completed without error
.Ip "\s-1LDAP_OPERATIONS_ERROR\s0" 4
.IX Item "LDAP_OPERATIONS_ERROR"
Server encountered an internal error
.Ip "\s-1LDAP_PROTOCOL_ERROR\s0" 4
.IX Item "LDAP_PROTOCOL_ERROR"
Unrecognized version number or incorrect \s-1PDU\s0 structure
.Ip "\s-1LDAP_TIMELIMIT_EXCEEDED\s0" 4
.IX Item "LDAP_TIMELIMIT_EXCEEDED"
The time limit on a search operation has been exceeded
.Ip "\s-1LDAP_SIZELIMIT_EXCEEDED\s0" 4
.IX Item "LDAP_SIZELIMIT_EXCEEDED"
The maximum number of search results to return has been exceeded.
.Ip "\s-1LDAP_COMPARE_FALSE\s0" 4
.IX Item "LDAP_COMPARE_FALSE"
This code is returned when a compare request completes and the attribute value
given is not in the entry specified
.Ip "\s-1LDAP_COMPARE_TRUE\s0" 4
.IX Item "LDAP_COMPARE_TRUE"
This code is returned when a compare request completes and the attribute value
given is in the entry specified
.Ip "\s-1LDAP_AUTH_METHOD_NOT_SUPPORTED\s0" 4
.IX Item "LDAP_AUTH_METHOD_NOT_SUPPORTED"
Unrecognized \s-1SASL\s0 mechanism name
.Ip "\s-1LDAP_STRONG_AUTH_REQUIRED\s0" 4
.IX Item "LDAP_STRONG_AUTH_REQUIRED"
The server requires authentication be performed with a \s-1SASL\s0 mechanism
.Ip "\s-1LDAP_PARTIAL_RESULTS\s0" 4
.IX Item "LDAP_PARTIAL_RESULTS"
Returned to version 2 clients when a referral is returned. The response
will contain a list of \s-1URL\s0's for other servers.
.Ip "\s-1LDAP_REFERRAL\s0" 4
.IX Item "LDAP_REFERRAL"
The server is referring the client to another server. The response will
contain a list of \s-1URL\s0's
.Ip "\s-1LDAP_ADMIN_LIMIT_EXCEEDED\s0" 4
.IX Item "LDAP_ADMIN_LIMIT_EXCEEDED"
The server has exceed the maximum number of entries to search while gathering
a list of search result candidates
.Ip "\s-1LDAP_UNAVAILABLE_CRITICAL_EXT\s0" 4
.IX Item "LDAP_UNAVAILABLE_CRITICAL_EXT"
A control or matching rule specified in the request is not supported by
the server
.Ip "\s-1LDAP_CONFIDENTIALITY_REQUIRED\s0" 4
.IX Item "LDAP_CONFIDENTIALITY_REQUIRED"
This result code is returned when confidentiality is required to perform
a given operation
.Ip "\s-1LDAP_SASL_BIND_IN_PROGRESS\s0" 4
.IX Item "LDAP_SASL_BIND_IN_PROGRESS"
The server requires the client to send a new bind request, with the same \s-1SASL\s0
mechanism, to continue the authentication process
.Ip "\s-1LDAP_NO_SUCH_ATTRIBUTE\s0" 4
.IX Item "LDAP_NO_SUCH_ATTRIBUTE"
The request referenced an attribute that does not exist
.Ip "\s-1LDAP_UNDEFINED_TYPE\s0" 4
.IX Item "LDAP_UNDEFINED_TYPE"
The request contains an undefined attribute type
.Ip "\s-1LDAP_INAPPROPRIATE_MATCHING\s0" 4
.IX Item "LDAP_INAPPROPRIATE_MATCHING"
An extensible matching rule in the given filter does not apply to the specified
attribute
.Ip "\s-1LDAP_CONSTRAINT_VIOLATION\s0" 4
.IX Item "LDAP_CONSTRAINT_VIOLATION"
The request contains a value which does not meet with certain constraints.
This result can be returned as a consequence of
.RS 4
.Ip "\(bu" 8
The request was to add or modify a user password, and the password fails to
meet the criteria the server is configured to check. This could be that the
password is too short, or a recognizable word (e.g. it matches one of the
attributes in the users entry) or it matches a previous password used by
the same user.
.Ip "\(bu" 8
The request is a bind request to a user account that has been locked
.RE
.RS 4
.RE
.Ip "\s-1LDAP_TYPE_OR_VALUE_EXISTS\s0" 4
.IX Item "LDAP_TYPE_OR_VALUE_EXISTS"
The request attempted to add an attribute type or value that already exists
.Ip "\s-1LDAP_INVALID_SYNTAX\s0" 4
.IX Item "LDAP_INVALID_SYNTAX"
Some part of the request contained an invalid syntax. It could be a search
with an invalid filter or a request to modify the schema and the given
schema has a bad syntax.
.Ip "\s-1LDAP_NO_SUCH_OBJECT\s0" 4
.IX Item "LDAP_NO_SUCH_OBJECT"
The server cannot find an object specified in the request
.Ip "\s-1LDAP_ALIAS_PROBLEM\s0" 4
.IX Item "LDAP_ALIAS_PROBLEM"
Server encountered a problem while attempting to dereference an alias
.Ip "\s-1LDAP_INVALID_DN_SYNTAX\s0" 4
.IX Item "LDAP_INVALID_DN_SYNTAX"
The request contained an invalid \s-1DN\s0
.Ip "\s-1LDAP_IS_LEAF\s0" 4
.IX Item "LDAP_IS_LEAF"
The specified entry is a leaf entry
.Ip "\s-1LDAP_ALIAS_DEREF_PROBLEM\s0" 4
.IX Item "LDAP_ALIAS_DEREF_PROBLEM"
Server encountered a problem while attempting to dereference an alias
.Ip "\s-1LDAP_INAPPROPRIATE_AUTH\s0" 4
.IX Item "LDAP_INAPPROPRIATE_AUTH"
The server requires the client which had attempted to bind anonymously or
without supplying credentials to provide some form of credentials
.Ip "\s-1LDAP_INVALID_CREDENTIALS\s0" 4
.IX Item "LDAP_INVALID_CREDENTIALS"
The wrong password was supplied or the \s-1SASL\s0 credentials could not be processed
.Ip "\s-1LDAP_INSUFFICIENT_ACCESS\s0" 4
.IX Item "LDAP_INSUFFICIENT_ACCESS"
The client does not have sufficient access to perform the requested
operation
.Ip "\s-1LDAP_BUSY\s0" 4
.IX Item "LDAP_BUSY"
The server is too busy to perform requested operation
.Ip "\s-1LDAP_UNAVAILABLE\s0" 4
.IX Item "LDAP_UNAVAILABLE"
The server in unavailable to perform the request, or the server is
shutting down
.Ip "\s-1LDAP_UNWILLING_TO_PERFORM\s0" 4
.IX Item "LDAP_UNWILLING_TO_PERFORM"
The server is unwilling to perform the requested operation
.Ip "\s-1LDAP_LOOP_DETECT\s0" 4
.IX Item "LDAP_LOOP_DETECT"
The server was unable to perform the request due to an internal loop detected
.Ip "\s-1LDAP_SORT_CONTROL_MISSING\s0" 4
.IX Item "LDAP_SORT_CONTROL_MISSING"
The search contained a \*(L"virtual list view\*(R" control, but not a server-side
sorting control, which is required when a \*(L"virtual list view\*(R" is given.
.Ip "\s-1LDAP_INDEX_RANGE_ERROR\s0" 4
.IX Item "LDAP_INDEX_RANGE_ERROR"
The search contained a control for a \*(L"virtual list view\*(R" and the results
exceeded the range specified by the requested offsets.
.Ip "\s-1LDAP_NAMING_VIOLATION\s0" 4
.IX Item "LDAP_NAMING_VIOLATION"
The request violates the structure of the \s-1DIT\s0
.Ip "\s-1LDAP_OBJECT_CLASS_VIOLATION\s0" 4
.IX Item "LDAP_OBJECT_CLASS_VIOLATION"
The request specifies a change to an existing entry or the addition of a new
entry that does not comply with the servers schema
.Ip "\s-1LDAP_NOT_ALLOWED_ON_NONLEAF\s0" 4
.IX Item "LDAP_NOT_ALLOWED_ON_NONLEAF"
The requested operation is not allowed on an entry that has child entries
.Ip "\s-1LDAP_NOT_ALLOWED_ON_RDN\s0" 4
.IX Item "LDAP_NOT_ALLOWED_ON_RDN"
The requested operation ill affect the \s-1RDN\s0 of the entry
.Ip "\s-1LDAP_ALREADY_EXISTS\s0" 4
.IX Item "LDAP_ALREADY_EXISTS"
The client attempted to add an entry that already exists. This can occur as
a result of
.RS 4
.Ip "\(bu" 8
An add request was submitted with a \s-1DN\s0 that already exists
.Ip "\(bu" 8
A modify \s-1DN\s0 requested was submitted, where the requested new \s-1DN\s0 already exists
.Ip "\(bu" 8
The request is adding an attribute to the schema and an attribute with the
given \s-1OID\s0 or name already exists
.RE
.RS 4
.RE
.Ip "\s-1LDAP_NO_OBJECT_CLASS_MODS\s0" 4
.IX Item "LDAP_NO_OBJECT_CLASS_MODS"
Request attempt to modify the object class of an entry that should not be
modified
.Ip "\s-1LDAP_RESULTS_TOO_LARGE\s0" 4
.IX Item "LDAP_RESULTS_TOO_LARGE"
The results of the request are to large
.Ip "\s-1LDAP_AFFECTS_MULTIPLE_DSAS\s0" 4
.IX Item "LDAP_AFFECTS_MULTIPLE_DSAS"
The requested operation needs to be performed on multiple servers where
the requested operation is not permitted
.Ip "\s-1LDAP_OTHER\s0" 4
.IX Item "LDAP_OTHER"
An unknown error has occurred
.Ip "\s-1LDAP_SERVER_DOWN\s0" 4
.IX Item "LDAP_SERVER_DOWN"
\&\f(CW\*(C`Net::LDAP\*(C'\fR cannot establish a connection or the connection has been lost
.Ip "\s-1LDAP_LOCAL_ERROR\s0" 4
.IX Item "LDAP_LOCAL_ERROR"
An error occurred in \f(CW\*(C`Net::LDAP\*(C'\fR
.Ip "\s-1LDAP_ENCODING_ERROR\s0" 4
.IX Item "LDAP_ENCODING_ERROR"
\&\f(CW\*(C`Net::LDAP\*(C'\fR encountered an error while encoding the request packet that would
have been sent to the server
.Ip "\s-1LDAP_DECODING_ERROR\s0" 4
.IX Item "LDAP_DECODING_ERROR"
\&\f(CW\*(C`Net::LDAP\*(C'\fR encountered an error while decoding a response packet from
the server.
.Ip "\s-1LDAP_TIMEOUT\s0" 4
.IX Item "LDAP_TIMEOUT"
\&\f(CW\*(C`Net::LDAP\*(C'\fR timeout while waiting for a response from the server
.Ip "\s-1LDAP_AUTH_UNKNOWN\s0" 4
.IX Item "LDAP_AUTH_UNKNOWN"
The method of authentication requested in a bind request is unknown to
the server
.Ip "\s-1LDAP_FILTER_ERROR\s0" 4
.IX Item "LDAP_FILTER_ERROR"
An error occurred while encoding the given search filter.
.Ip "\s-1LDAP_USER_CANCELED\s0" 4
.IX Item "LDAP_USER_CANCELED"
The user canceled the operation
.Ip "\s-1LDAP_PARAM_ERROR\s0" 4
.IX Item "LDAP_PARAM_ERROR"
An invalid parameter was specified
.Ip "\s-1LDAP_NO_MEMORY\s0" 4
.IX Item "LDAP_NO_MEMORY"
Out of memory error
.Ip "\s-1LDAP_CONNECT_ERROR\s0" 4
.IX Item "LDAP_CONNECT_ERROR"
A connection to the server could not be established
.Ip "\s-1LDAP_NOT_SUPPORTED\s0" 4
.IX Item "LDAP_NOT_SUPPORTED"
An attempt has been made to use a feature not supported by Net::LDAP
.Ip "\s-1LDAP_CONTROL_NOT_FOUND\s0" 4
.IX Item "LDAP_CONTROL_NOT_FOUND"
The controls required to perform the requested operation were not
found.
.Ip "\s-1LDAP_NO_RESULTS_RETURNED\s0" 4
.IX Item "LDAP_NO_RESULTS_RETURNED"
No results were returned from the server.
.Ip "\s-1LDAP_MORE_RESULTS_TO_RETURN\s0" 4
.IX Item "LDAP_MORE_RESULTS_TO_RETURN"
There are more results in the chain of results.
.Ip "\s-1LDAP_CLIENT_LOOP\s0" 4
.IX Item "LDAP_CLIENT_LOOP"
A loop has been detected. For example when following referals.
.Ip "\s-1LDAP_REFERRAL_LIMIT_EXCEEDED\s0" 4
.IX Item "LDAP_REFERRAL_LIMIT_EXCEEDED"
The referral hop limit has been exceeded.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
the Net::LDAP manpage,
the Net::LDAP::Message manpage
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com>
.PP
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl-ldap-dev@lists.sourceforge.net>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1998\-2000 Graham Barr. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.
.PP
\&\fI$Id: Constant.pod,v 1.3 2001/08/24 19:31:14 gbarr Exp $\fR