Net::LDAP::Control::SorUtsReersuClotn(t3r)ibuted Perl DoNceutm:e:nLtDaAtPi:o:nControl::SortResult(3)

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

SYNOPSIS
        use Net::LDAP::Control::Sort;
        use Net::LDAP::Constant qw(LDAPCONTROLSORTRESULT);
        use Net::LDAP::Util qw(ldaperrorname);

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

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

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

        if ($resp) {
          if ($resp->result) {
            my $attr = $resp->attr;
            print "Problem sorting, ",ldaperrorname($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 of Net::LDAP::Control.
       It provides a class for manipulating the LDAP sort request control
       1.2.840.113556.1.4.474 as defined in RFC-2891

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

CCOONNSSTTRRUUCCTTOORR AARRGGUUMMEENNTTSS
       attr
           If "result" indicates that there was a problem with sorting and
           that problem was due to one of the attributes specified in the sort
           control. "attr" is set to the name of the attribute causing the
           problem.

       result
           This is the result code that describes if the sort operation was
           sucessful. If will be one of the result codes describes below.

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

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

       LDAPSUCCESS
       LDAPOPERATIONSERROR
       LDAPTIMELIMITEXCEEDED
       LDAPSTRONGAUTHREQUIRED
       LDAPADMINLIMITEXCEEDED
       LDAPNOSUCHATTRIBUTE
       LDAPINAPPROPRIATEMATCHING
       LDAPINSUFFICIENTACCESS
       LDAPBUSY
       LDAPUNWILLINGTOPERFORM
       LDAPOTHER

SEE ALSO
       Net::LDAP, Net::LDAP::Control::Sort, Net::LDAP::Control,
       http://ww.ietf.org/rfc/rfc2891.txt

AUTHOR       Graham Barr 

       Please report any bugs, or post any suggestions, to the perl-ldap
       mailing list 

COPYRIGHT
       Copyright (c) 1999-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.



perl v5.8.8                       2005-04-25 Net::LDAP::Control::SortResult(3)