Net::LDAP::Message - Message response from LDAP server
|
Net::LDAP::Message - Message response from LDAP server
use Net::LDAP;
Net::LDAP::Message is a base class for the objects returned by the
the Net::LDAP manpage methods
abandon,
add,
bind,
compare,
delete,
modify,
moddn,
search and
unbind.
The sub-class the Net::LDAP::Search manpage returned by search also
defines many methods.
If the the Net::LDAP manpage object is in async mode then all these methods, except
done
, will cause a wait until the request is completed.
- code
-
The code value in the result message from the server. Normally for
a success zero will be returned. Constants for the result codes
can be imported from the the Net::LDAP manpage or the Net::LDAP::Constant manpage module.
- control [ OID ]
-
Return a list of controls returned from the server. If OID is given
then only controls with type equal to OID will be returned.
- dn
-
The DN in the result message from the server.
- done
-
Returns true if the request has been completed.
- error
-
Returns the error message in the result message from the server. If
the server did not include an error message, then the result of
ldap_error_desc with the error code
from the result message.
- error_name
-
Returns the name of the error code in the result message from the
server. See ldap_error_name for a
detailed description of the return value.
- error_text
-
Returns the short text description of the error code in the result
message from the server. See
ldap_error_text for a detailed
description of the return value.
- error_desc
-
Returns a long text description of the error code in the result
message from the server. See
ldap_error_desc for a detailed
description of the return value.
- is_error
-
Returns true if the result code is considered to be an error for the operation.
- mesg_id
-
The message id of the request message sent to the server.
- referrals
-
Returns a list of referrals from the result message.
- server_error
-
The error message returned by the server, or undef if the server did not provide
a message.
- sync
-
Wait for the server to complete the request.
the Net::LDAP manpage,
the Net::LDAP::Search manpage,
the Net::LDAP::Constant manpage,
the Net::LDAP::Util manpage
This document is based on a document originally written by Russell Fulton
<r.fulton@auckland.ac.nz>.
Graham Barr <gbarr@pobox.com>
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl-ldap@perl.org>.
Copyright (c) 1997-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.
$Id: Message.pod,v 1.7 2003/05/20 14:56:04 chrisridd Exp $
Net::LDAP::Message - Message response from LDAP server
|