home *** CD-ROM | disk | FTP | other *** search
Wrap
<HTML> <HEAD> <TITLE>Net::LDAP::Message -- Message response from LDAP server</TITLE> <LINK REL="stylesheet" HREF="../../../../Active.css" TYPE="text/css"> <LINK REV="made" HREF="mailto:"> </HEAD> <BODY> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> <STRONG><P CLASS=block> Net::LDAP::Message -- Message response from LDAP server</P></STRONG> </TD></TR> </TABLE> <A NAME="__index__"></A> <!-- INDEX BEGIN --> <UL> <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI> <LI><A HREF="#synopsis">SYNOPSIS</A></LI> <LI><A HREF="#description">DESCRIPTION</A></LI> <LI><A HREF="#methods">METHODS</A></LI> <LI><A HREF="#see also">SEE ALSO</A></LI> <LI><A HREF="#acknowledgements">ACKNOWLEDGEMENTS</A></LI> <LI><A HREF="#author">AUTHOR</A></LI> <LI><A HREF="#copyright">COPYRIGHT</A></LI> </UL> <!-- INDEX END --> <HR> <P> <H1><A NAME="name">NAME</A></H1> <P>Net::LDAP::Message -- Message response from LDAP server</P> <P> <HR> <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1> <UL> <LI>Linux</LI> <LI>Solaris</LI> <LI>Windows</LI> </UL> <HR> <H1><A NAME="synopsis">SYNOPSIS</A></H1> <PRE> use Net::LDAP;</PRE> <P> <HR> <H1><A NAME="description">DESCRIPTION</A></H1> <P><STRONG>Net::LDAP::Message</STRONG> is a base class for the objects returned by the <A HREF="../../../../site/lib/Net/LDAP.html">the Net::LDAP manpage</A> methods <A HREF="../../../../site/lib/Net/LDAP.html#abandon( id [, options])">abandon</A>, <A HREF="../../../../site/lib/Net/LDAP.html#add( dn [,options ])">add</A>, <A HREF="../../../../site/lib/Net/LDAP.html#bind( dn [, options])">bind</A>, <A HREF="../../../../site/lib/Net/LDAP.html#compare( dn [, options])">compare</A>, <A HREF="../../../../site/lib/Net/LDAP.html#delete( dn [, options])">delete</A>, <A HREF="../../../../site/lib/Net/LDAP.html#modify( dn [, options])">modify</A>, <A HREF="../../../../site/lib/Net/LDAP.html#moddn( dn [, options])">moddn</A>, <A HREF="../../../../site/lib/Net/LDAP.html#search(options)">search</A> and <A HREF="../../../../site/lib/Net/LDAP.html#unbind">unbind</A>.</P> <P>The sub-class <A HREF="../../../../site/lib/Net/LDAP/Search.html">the Net::LDAP::Search manpage</A> returned by <A HREF="../../../../site/lib/Net/LDAP.html#search(options)">search</A> also defines many methods.</P> <P>If the <A HREF="../../../../site/lib/Net/LDAP.html">the Net::LDAP manpage</A> object is in async mode then all these methods, except <A HREF="#item_done"><CODE>done</CODE></A>, will cause a wait until the request is completed.</P> <P> <HR> <H1><A NAME="methods">METHODS</A></H1> <DL> <DT><STRONG><A NAME="item_code">code</A></STRONG><BR> <DD> The code value in the result message from the server. Normally for a success zero will be returned. <A HREF="../../../../site/lib/Net/LDAP/Constant.html">Constants</A> for the result codes can be imported from the <A HREF="../../../../site/lib/Net/LDAP.html">the Net::LDAP manpage</A> module. <P></P> <DT><STRONG><A NAME="item_error">error</A></STRONG><BR> <DD> The error message in the result message from the server. <P></P> <DT><STRONG><A NAME="item_mesg_id">mesg_id</A></STRONG><BR> <DD> The message id of the request message sent to the server. <P></P> <DT><STRONG><A NAME="item_done">done</A></STRONG><BR> <DD> Returns <EM>true</EM> if the request has been completed. <P></P> <DT><STRONG><A NAME="item_dn">dn</A></STRONG><BR> <DD> The DN in the result message from the server. <P></P> <DT><STRONG><A NAME="item_sync">sync</A></STRONG><BR> <DD> Wait for the server to complete the request. <P></P> <DT><STRONG><A NAME="item_referrals">referrals</A></STRONG><BR> <DD> Returns a list of referrals from the result message. <P></P></DL> <P> <HR> <H1><A NAME="see also">SEE ALSO</A></H1> <P><A HREF="../../../../site/lib/Net/LDAP.html">the Net::LDAP manpage</A>, <A HREF="../../../../site/lib/Net/LDAP/Search.html">the Net::LDAP::Search manpage</A>, <A HREF="../../../../Net/LDAP/Constants.html">the Net::LDAP::Constants manpage</A></P> <P> <HR> <H1><A NAME="acknowledgements">ACKNOWLEDGEMENTS</A></H1> <P>This document is based on a document originally written by Russell Fulton <<EM><A HREF="mailto:r.fulton@auckland.ac.nz">r.fulton@auckland.ac.nz</A></EM>>.</P> <P> <HR> <H1><A NAME="author">AUTHOR</A></H1> <P>Graham Barr <<EM><A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A></EM>></P> <P> <HR> <H1><A NAME="copyright">COPYRIGHT</A></H1> <P>Copyright (c) 1997-1999 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.</P> <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%> <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc"> <STRONG><P CLASS=block> Net::LDAP::Message -- Message response from LDAP server</P></STRONG> </TD></TR> </TABLE> </BODY> </HTML>