home *** CD-ROM | disk | FTP | other *** search
<HTML> <HEAD> <TITLE>Net::LDAP::Search -- Object returned by Net::LDAP search method</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::Search -- Object returned by Net::LDAP search method</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::Search -- Object returned by Net::LDAP search method</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> <PRE> $mesg = $ldap->search( @search_args );</PRE> <PRE> @entries = $mesg->entries;</PRE> <P> <HR> <H1><A NAME="description">DESCRIPTION</A></H1> <P>A Net::LDAP::Search object is returned from the <A HREF="../../../../site/lib/Net/LDAP.html#search(options)">search</A> method of a <A HREF="../../../../site/lib/Net/LDAP.html">the Net::LDAP manpage</A> object. It is a container object which holds the results of the search.</P> <P> <HR> <H1><A NAME="methods">METHODS</A></H1> <P>Net::LDAP::Search inherits from <A HREF="../../../../site/lib/Net/LDAP/Message.html">the Net::LDAP::Message manpage</A>, and so supports all methods defined in <A HREF="../../../../site/lib/Net/LDAP/Message.html">the Net::LDAP::Message manpage</A>.</P> <DL> <DT><STRONG><A NAME="item_as_struct">as_struct</A></STRONG><BR> <DD> Returns a reference to a HASH, where the keys are the DN's of the results and the values are HASH references. These second level HASH's hold the attributes such that the keys are the attribute names, in lowercase, and the values are references to and ARRAY holding the values. <P>This method will block until the whole search request has finished.</P> <P></P> <DT><STRONG><A NAME="item_count">count</A></STRONG><BR> <DD> Returns the number of entries returned by the server. <P>This method will block until the whole search request has finished.</P> <P></P> <DT><STRONG><A NAME="item_entry">entry ( INDEX )</A></STRONG><BR> <DD> Return the N'th entry, which will be a <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A> object. If INDEX is greater than the total number of entries returned then undef will be returned. <P>This method will block until the search request has returned enough entries.</P> <P></P> <DT><STRONG><A NAME="item_entries">entries</A></STRONG><BR> <DD> Return an array of <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A> objects hat were returned from the server. <P>This method will block until the whole search request has finished.</P> <P></P> <DT><STRONG><A NAME="item_pop_entry">pop_entry</A></STRONG><BR> <DD> Pop an entry from the internal list of <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A> objects for this search. If there are not more entries then undef is returned. <P>This call will block, if the list is empty, until the server returns another entry.</P> <P></P> <DT><STRONG><A NAME="item_references">references</A></STRONG><BR> <DD> Return a list of references that the server returned. This will be a list of <A HREF="../../../../site/lib/Net/LDAP/Reference.html">the Net::LDAP::Reference manpage</A> objects. <P></P> <DT><STRONG><A NAME="item_sorted">sorted ( [ ATTR ] )</A></STRONG><BR> <DD> Return a list of <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A> objects, sorted by ATTR. If ATTR is not given then the entries will be sorted by their DN. <P></P> <DT><STRONG><A NAME="item_shift_entry">shift_entry</A></STRONG><BR> <DD> Shift an entry from the internal list of <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A> objects for this search. If there are not more entries then undef is returned. <P>This call will block, if the list is empty, until the server returns another entry.</P> <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/Message.html">the Net::LDAP::Message manpage</A>, <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A>, <A HREF="../../../../site/lib/Net/LDAP/Reference.html">the Net::LDAP::Reference 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::Search -- Object returned by Net::LDAP search method</P></STRONG> </TD></TR> </TABLE> </BODY> </HTML> 
