Help-Site Computer Manuals
Software
Hardware
Programming
Networking
  Algorithms & Data Structures   Programming Languages   Revision Control
  Protocols
  Cameras   Computers   Displays   Keyboards & Mice   Motherboards   Networking   Printers & Scanners   Storage
  Windows   Linux & Unix   Mac

Net::LDAP::Search
Object returned by Net::LDAP search method

Net::LDAP::Search - Object returned by Net::LDAP search method


NAME

Net::LDAP::Search - Object returned by Net::LDAP search method


SYNOPSIS


 use Net::LDAP;

 $mesg = $ldap->search( @search_args );

 @entries = $mesg->entries;


DESCRIPTION

A Net::LDAP::Search object is returned from the search method of a the Net::LDAP manpage object. It is a container object which holds the results of the search.


METHODS

Net::LDAP::Search inherits from the Net::LDAP::Message manpage, and so supports all methods defined in the Net::LDAP::Message manpage.

as_struct ( )
Returns a reference to a HASH, where the keys are the DNs of the results and the values are HASH references. These second level HASHes hold the attributes such that the keys are the attribute names, in lowercase, and the values are references to an ARRAY holding the values.

This method will block until the whole search request has finished.

count ( )
Returns the number of entries returned by the server.

This method will block until the whole search request has finished.

entry ( INDEX )
Return the N'th entry, which will be a the Net::LDAP::Entry manpage object. If INDEX is greater than the total number of entries returned then undef will be returned.

This method will block until the search request has returned enough entries.

entries ( )
Return an array of the Net::LDAP::Entry manpage objects that were returned from the server.

This method will block until the whole search request has finished.

pop_entry ( )
Pop an entry from the internal list of the Net::LDAP::Entry manpage objects for this search. If there are no more entries then undef is returned.

This call will block if the list is empty, until the server returns another entry.

references ( )
Return a list of references that the server returned. This will be a list of the Net::LDAP::Reference manpage objects.

sorted ( )
Return a list the Net::LDAP:Entry manpage objects, sorted by their DNs.

sorted ( ATTR, ... )
Return a list of the Net::LDAP::Entry manpage objects, sorted by the specified attributes. The attributes are compared in the order specified, each only being compared if all the prior attributes compare equal.

shift_entry ( )
Shift an entry from the internal list of the Net::LDAP::Entry manpage objects for this search. If there are no more entries then undef is returned.

This call will block if the list is empty, until the server returns another entry.


SEE ALSO

the Net::LDAP manpage, the Net::LDAP::Message manpage, the Net::LDAP::Entry manpage, the Net::LDAP::Reference manpage


ACKNOWLEDGEMENTS

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


AUTHOR

Graham Barr <gbarr@pobox.com>

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


COPYRIGHT

Copyright (c) 1997-2004 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.

Programminig
Wy
Wy
yW
Wy
Programming
Wy
Wy
Wy
Wy