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 ob‐
26       tained by a call to the ldap_parse_result function. A returncode  which
27       points  to  the  sort  control  result code,and an array of LDAPControl
28       structures that list the client controls to use with the  search.   The
29       function  also  takes an out parameter attribute and if the sort opera‐
30       tion fails, the server may return a string that indicates the first at‐
31       tribute  in the sortKey list that caused the failure. If this parameter
32       is NULL, no string is returned. If a string  is  returned,  the  memory
33       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 the Uni‐
42       versity of Michigan LDAP 3.3 Release.
43
44
45
46OpenLDAP                          2021/06/03        LDAP_PARSE_SORT-CONTROL(3)



        

    


            
        

        

            Impressum