MAN page from Fedora 6 perl-Net-LDAP-0.3202-1.2.fc6.rf.noarch.rpm

Net::LDAP::Control::SortResult

Section: User Contributed Perl Documentation (3)
Updated: 2004-07-19
Index

NAME

Net::LDAP::Control::SortResult - Server Side Sort (SSS) result control object

SYNOPSIS

 use Net::LDAP::Control::Sort; use Net::LDAP::Constant qw(LDAP_CONTROL_SORTRESULT); use Net::LDAP::Util qw(ldap_error_name);

 $sort = Net::LDAP::Control::Sort->new(   order => "cn -age" );

 $mesg = $ldap->search( @args, control => [ $sort ]);

 ($resp) = $mesg->control( LDAP_CONTROL_SORTRESULT );

 if ($resp) {   if ($resp->result) {     my $attr = $resp->attr;     print "Problem sorting, ",ldap_error_name($resp->result);     print " ($attr)" if $attr;     print "\n";   }   else {     print "Results are sorted\n";   } } else {   print "Server does not support sorting\n"; }

DESCRIPTION

"Net::LDAP::Control::SortResult" is a sub-class ofNet::LDAP::Control. It provides a class formanipulating the LDAP sort request control 1.2.840.113556.1.4.474as defined in RFC-2891

A sort result control will be returned by the server in response toa search with a Server Side Sort control. If a sort result control isnot returned then the user may assume that the server does not supportsorting and the results are not sorted.

CONSTRUCTOR ARGUMENTS

attr: If "result" indicates that there was a problem with sorting and that problem wasdue to one of the attributes specified in the sort control. "attr" is set tothe name of the attribute causing the problem.
result: This is the result code that describes if the sort operation was sucessful. If willbe one of the result codes describes below.

METHODS

As with Net::LDAP::Control each constructor argumentdescribed above is also avaliable as a method on the object which willreturn the current value for the attribute if called without an argument,and set a new value for the attribute if called with an argument.

RESULT CODES

Possible results from a sort request are listed below. See Net::LDAP::Constant fora definition of each.

LDAP_SUCCESS
LDAP_OPERATIONS_ERROR
LDAP_TIMELIMIT_EXCEEDED
LDAP_STRONG_AUTH_REQUIRED
LDAP_ADMIN_LIMIT_EXCEEDED
LDAP_NO_SUCH_ATTRIBUTE
LDAP_INAPPROPRIATE_MATCHING
LDAP_INSUFFICIENT_ACCESS
LDAP_BUSY
LDAP_UNWILLING_TO_PERFORM
LDAP_OTHER

AUTHOR

Graham Barr <gbarrAATTpobox.com>

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

COPYRIGHT

This document was created byman2html,using the manual pages.