From: Chris R. <chr...@us...> - 2003-08-01 17:17:06
|
Update of /cvsroot/perl-ldap/ldap/lib/Net/LDAP In directory sc8-pr-cvs1:/tmp/cvs-serv18169 Modified Files: Search.pod Log Message: Updated documentation style. Index: Search.pod =================================================================== RCS file: /cvsroot/perl-ldap/ldap/lib/Net/LDAP/Search.pod,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- Search.pod 7 May 2003 11:17:06 -0000 1.5 +++ Search.pod 1 Aug 2003 16:34:42 -0000 1.6 @@ -4,35 +4,36 @@ =head1 SYNOPSIS - use Net::LDAP; + use Net::LDAP; - $mesg = $ldap->search( @search_args ); + $mesg = $ldap->search( @search_args ); - @entries = $mesg->entries; + @entries = $mesg->entries; =head1 DESCRIPTION A B<Net::LDAP::Search> object is returned from the -L<search|Net::LDAP/item_search> method of a L<Net::LDAP> -object. It is a container object which holds the results of the search. +L<search|Net::LDAP/item_search> method of a L<Net::LDAP> object. It is +a container object which holds the results of the search. =head1 METHODS -B<Net::LDAP::Search> inherits from L<Net::LDAP::Message>, and so supports -all methods defined in L<Net::LDAP::Message>. +B<Net::LDAP::Search> inherits from L<Net::LDAP::Message>, and so +supports all methods defined in L<Net::LDAP::Message>. =over 4 -=item as_struct +=item as_struct ( ) -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. +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 and ARRAY holding the +values. This method will block until the whole search request has finished. -=item count +=item count ( ) Returns the number of entries returned by the server. @@ -42,45 +43,48 @@ Return the N'th entry, which will be a L<Net::LDAP::Entry> object. If INDEX is greater than the total number of entries returned then -undef will be returned. +C<undef> will be returned. This method will block until the search request has returned enough entries. -=item entries +=item entries ( ) -Return an array of L<Net::LDAP::Entry> objects hat were returned from the -server. +Return an array of L<Net::LDAP::Entry> objects that were returned from +the server. This method will block until the whole search request has finished. -=item pop_entry +=item pop_entry ( ) -Pop an entry from the internal list of L<Net::LDAP::Entry> objects for this -search. If there are not more entries then undef is returned. +Pop an entry from the internal list of L<Net::LDAP::Entry> objects for +this search. If there are no more entries then C<undef> is returned. -This call will block, if the list is empty, until the server returns +This call will block if the list is empty, until the server returns another entry. -=item references +=item references ( ) -Return a list of references that the server returned. This will be a list -of L<Net::LDAP::Reference> objects. +Return a list of references that the server returned. This will be a +list of L<Net::LDAP::Reference> objects. -=item sorted ( [ ATTR_LIST ] ) +=item sorted ( ) -Return a list of L<Net::LDAP::Entry> objects, -sorted by the attributes given in ATTR_LIST. The attributes are -compared in the order specified, each only being compared if all -the prior attributes compare equal. If all the specified attributes -compare equal then the DN is used to determine order. +Return a list L<Net::LDAP:Entry> objects, sorted by their DNs. -=item shift_entry +=item sorted ( ATTR, ... ) -Shift an entry from the internal list of L<Net::LDAP::Entry> objects for this -search. If there are not more entries then undef is returned. +Return a list of L<Net::LDAP::Entry> 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. -This call will block, if the list is empty, until the server returns +=item shift_entry ( ) + +Shift an entry from the internal list of L<Net::LDAP::Entry> objects +for this search. If there are no more entries then C<undef> is +returned. + +This call will block if the list is empty, until the server returns another entry. =back @@ -94,21 +98,21 @@ =head1 ACKNOWLEDGEMENTS -This document is based on a document originally written by Russell Fulton -E<lt>r.f...@au...E<gt>. +This document is based on a document originally written by Russell +Fulton E<lt>r.f...@au...E<gt>. =head1 AUTHOR Graham Barr E<lt>gb...@po...E<gt> -Please report any bugs, or post any suggestions, to the perl-ldap mailing list -E<lt>per...@pe...E<gt>. +Please report any bugs, or post any suggestions, to the perl-ldap +mailing list E<lt>per...@pe...E<gt>. =head1 COPYRIGHT -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. +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. =for html <hr> |