1LDAP_PARSE_SORT-CONTROL(3) Library Functions Manual LDAP_PARSE_SORT-CONTROL(3)
2
3
4

NAME

6       ldap_parse_sort_control - Decode the information returned from a search
7       operation that used a server-side sort control
8

LIBRARY

10       OpenLDAP LDAP (libldap, -lldap)
11

SYNOPSIS

13       #include <ldap.h>
14
15       int ldap_parse_sort_control(ld, ctrls, returnCode, attribute)
16       LDAP *ld;
17       LDAPControl **ctrls;
18       unsigned long *returnCode;
19       char **attribute;
20

DESCRIPTION

22       This function is used to parse the results returned in a search  opera‐
23       tion that uses a server-side sort control.
24
25       It  takes  a  null  terminated  array of LDAPControl structures usually
26       obtained by a call to  the  ldap_parse_result  function.  A  returncode
27       which  points  to the sort control result code,and an array of LDAPCon‐
28       trol structures that list the client controls to use with  the  search.
29       The  function  also  takes  an  out parameter attribute and if the sort
30       operation fails, the server may return  a  string  that  indicates  the
31       first  attribute  in  the sortKey list that caused the failure. If this
32       parameter is NULL, no string is returned. If a string is returned,  the
33       memory should be freed by calling the ldap_memfree function.
34

NOTES

SEE ALSO
37       ldap_result(3), ldap_controls_free(3)
38

ACKNOWLEDGEMENTS
40       OpenLDAP  Software  is developed and maintained by The OpenLDAP Project
41       <http://www.openldap.org/>.  OpenLDAP Software is derived from  Univer‐
42       sity of Michigan LDAP 3.3 Release.
43
44
45
46OpenLDAP 2.4.23                   2010/06/30        LDAP_PARSE_SORT-CONTROL(3)



        

    


            
        

        

            Impressum