\section{NAME\label{NAME-message}}


Net::LDAP::Message - Message response from LDAP server

\section{SYNOPSIS\label{SYNOPSIS-message}\index{synopsis of Net::LDAP::Message}}
\begin{verbatim}
 use Net::LDAP;
\end{verbatim}
\section{DESCRIPTION\label{DESCRIPTION-message}\index{description of Net::LDAP::Message}}


\textbf{Net::LDAP::Message} is a base class for the objects returned by the
\emph{Net::LDAP} methods
\textsf{abandon},
\textsf{add},
\textsf{bind},
\textsf{compare},
\textsf{delete},
\textsf{modify},
\textsf{moddn},
\textsf{search} and
\textsf{unbind}.



The sub-class \emph{Net::LDAP::Search} returned by
\textsf{search} also defines many methods.



If the \emph{Net::LDAP} object is in async mode then all these methods,
except \texttt{done}, will cause a wait until the request is completed.

\section{METHODS\label{METHODS-message}\index{methods of Net::LDAP::Message}}
\begin{description}

\item[code ()] \index{code() --- Net::LDAP::Message method}\mbox{}

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 \emph{Net::LDAP} or \emph{Net::LDAP::Constant} module.


\item[control ()] \mbox{}

Return a list of controls that were returned from the server.


\item[control ( OID, ... )] \mbox{}

Return a list of controls with the given OIDs that were returned from
the server.


\item[dn ()] \index{dn() --- Net::LDAP::Message method}\mbox{}

The DN in the result message from the server.


\item[done ()] \mbox{}

Returns \textit{true} if the request has been completed.


\item[error ()] \index{error() --- Net::LDAP::Message method}\mbox{}

Returns the error message in the result message from the server. If
the server did not include an error message, then the result of
\textsf{ldap\_error\_desc} with the error code
from the result message.


\item[error\_name ()] \mbox{}

Returns the name of the error code in the result message from the
server. See \textsf{ldap\_error\_name$|$Net::LDAP::Util::ldap\_error\_name} for a
detailed description of the return value.


\item[error\_text ()] \mbox{}

Returns the short text description of the error code in the result
message from the server. See
\textsf{ldap\_error\_text$|$Net::LDAP::Util::ldap\_error\_text} for a detailed
description of the return value.


\item[error\_desc ()] \mbox{}

Returns a long text description of the error code in the result
message from the server. See
\textsf{ldap\_error\_desc$|$Net::LDAP::Util::ldap\_error\_desc} for a detailed
description of the return value.


\item[is\_error ()] \mbox{}

Returns \textit{true} if the result code is considered to be an error for
the operation.


\item[mesg\_id ()] \mbox{}

The message id of the request message sent to the server.


\item[referrals ()] \mbox{}

Returns a list of referrals from the result message.


\item[server\_error ()] \mbox{}

The error message returned by the server, or \texttt{undef} if the server
did not provide a message.


\item[sync ()] \mbox{}

Wait for the server to complete the request.

\end{description}
\section{SEE ALSO\label{SEE_ALSO-Message}\index{see also for Net::LDAP::Message}}


\emph{Net::LDAP},
\emph{Net::LDAP::Search},
\emph{Net::LDAP::Constant},
\emph{Net::LDAP::Util}

\section{ACKNOWLEDGEMENTS\label{ACKNOWLEDGEMENTS-Message}}


This document is based on a document originally written by Russell
Fulton $<$r.fulton@auckland.ac.nz$>$.

\section{AUTHOR\label{AUTHOR-Message}}


Graham Barr $<$gbarr@pobox.com$>$



Please report any bugs, or post any suggestions, to the perl-ldap
mailing list $<$perl-ldap@perl.org$>$.

\section{COPYRIGHT\label{COPYRIGHT-message}}


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.



\textit{\$Id: Message.pod,v 1.8 2003/08/01 18:42:47 chrisridd Exp \$}

