home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _a50bf3b98051d6a6147ba56ac98cf79f < prev    next >
Text File  |  2000-03-23  |  6KB  |  148 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Net::LDAP::Search -- Object returned by Net::LDAP search method</TITLE>
  5. <LINK REL="stylesheet" HREF="../../../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Net::LDAP::Search -- Object returned by Net::LDAP search method</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#methods">METHODS</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27.     <LI><A HREF="#acknowledgements">ACKNOWLEDGEMENTS</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>Net::LDAP::Search -- Object returned by Net::LDAP search method</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.   use Net::LDAP;
  49. </PRE>
  50. <PRE>
  51.  
  52.   $mesg = $ldap->search( @search_args );</PRE>
  53. <PRE>
  54.  
  55.   @entries = $mesg->entries;</PRE>
  56. <P>
  57. <HR>
  58. <H1><A NAME="description">DESCRIPTION</A></H1>
  59. <P>A Net::LDAP::Search object is returned from the
  60. <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>
  61. object. It is a container object which holds the results of the search.</P>
  62. <P>
  63. <HR>
  64. <H1><A NAME="methods">METHODS</A></H1>
  65. <P>Net::LDAP::Search inherits from <A HREF="../../../../site/lib/Net/LDAP/Message.html">the Net::LDAP::Message manpage</A>, and so supports
  66. all methods defined in <A HREF="../../../../site/lib/Net/LDAP/Message.html">the Net::LDAP::Message manpage</A>.</P>
  67. <DL>
  68. <DT><STRONG><A NAME="item_as_struct">as_struct</A></STRONG><BR>
  69. <DD>
  70. Returns a reference to a HASH, where the keys are the DN's of the results
  71. and the values are HASH references. These second level HASH's hold the
  72. attributes such that the keys are the attribute names, in lowercase, and
  73. the values are references to and ARRAY holding the values.
  74. <P>This method will block until the whole search request has finished.</P>
  75. <P></P>
  76. <DT><STRONG><A NAME="item_count">count</A></STRONG><BR>
  77. <DD>
  78. Returns the number of entries returned by the server.
  79. <P>This method will block until the whole search request has finished.</P>
  80. <P></P>
  81. <DT><STRONG><A NAME="item_entry">entry ( INDEX )</A></STRONG><BR>
  82. <DD>
  83. 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
  84. INDEX is greater than the total number of entries returned then
  85. undef will be returned.
  86. <P>This method will block until the search request has returned enough
  87. entries.</P>
  88. <P></P>
  89. <DT><STRONG><A NAME="item_entries">entries</A></STRONG><BR>
  90. <DD>
  91. Return an array of <A HREF="../../../../site/lib/Net/LDAP/Entry.html">the Net::LDAP::Entry manpage</A> objects hat were returned from the
  92. server.
  93. <P>This method will block until the whole search request has finished.</P>
  94. <P></P>
  95. <DT><STRONG><A NAME="item_pop_entry">pop_entry</A></STRONG><BR>
  96. <DD>
  97. 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
  98. search. If there are not more entries then undef is returned.
  99. <P>This call will block, if the list is empty, until the server returns
  100. another entry.</P>
  101. <P></P>
  102. <DT><STRONG><A NAME="item_references">references</A></STRONG><BR>
  103. <DD>
  104. Return a list of references that the server returned. This will be a list
  105. of <A HREF="../../../../site/lib/Net/LDAP/Reference.html">the Net::LDAP::Reference manpage</A> objects.
  106. <P></P>
  107. <DT><STRONG><A NAME="item_sorted">sorted ( [ ATTR ] )</A></STRONG><BR>
  108. <DD>
  109. 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
  110. not given then the entries will be sorted by their DN.
  111. <P></P>
  112. <DT><STRONG><A NAME="item_shift_entry">shift_entry</A></STRONG><BR>
  113. <DD>
  114. 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
  115. search. If there are not more entries then undef is returned.
  116. <P>This call will block, if the list is empty, until the server returns
  117. another entry.</P>
  118. <P></P></DL>
  119. <P>
  120. <HR>
  121. <H1><A NAME="see also">SEE ALSO</A></H1>
  122. <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>,
  123. <A HREF="../../../../site/lib/Net/LDAP/Reference.html">the Net::LDAP::Reference manpage</A></P>
  124. <P>
  125. <HR>
  126. <H1><A NAME="acknowledgements">ACKNOWLEDGEMENTS</A></H1>
  127. <P>This document is based on a document originally written by Russell Fulton
  128. <<EM><A HREF="mailto:r.fulton@auckland.ac.nz">r.fulton@auckland.ac.nz</A></EM>>.</P>
  129. <P>
  130. <HR>
  131. <H1><A NAME="author">AUTHOR</A></H1>
  132. <P>Graham Barr <<EM><A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A></EM>></P>
  133. <P>
  134. <HR>
  135. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  136. <P>Copyright (c) 1997-1999 Graham Barr. All rights reserved. This program is
  137. free software; you can redistribute it and/or modify it under the same
  138. terms as Perl itself.</P>
  139. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  140. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  141. <STRONG><P CLASS=block> Net::LDAP::Search -- Object returned by Net::LDAP search method</P></STRONG>
  142. </TD></TR>
  143. </TABLE>
  144.  
  145. </BODY>
  146.  
  147. </HTML>
  148.