NAME | LIBRARY | SYNOPSIS | DESCRIPTION | NOTES | SEE ALSO | ACKNOWLEDGEMENTS | COLOPHON

LDAP_PARSE_SORT-CONTROL(3)Library Functions ManualLDAP_PARSE_SORT-CONTROL(3)

NAME         top

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

LIBRARY         top

       OpenLDAP LDAP (libldap, -lldap)

SYNOPSIS         top

       #include <ldap.h>

       int ldap_parse_sort_control(ld, ctrls, returnCode, attribute)
       LDAP *ld;
       LDAPControl **ctrls;
       unsigned long *returnCode;
       char **attribute;

DESCRIPTION         top

       This function is used to parse the results returned in a search
       operation that uses a server-side sort control.

       It takes a null terminated array of LDAPControl structures usually
       obtained by a call to the ldap_parse_result function. A returncode
       which points to the sort control result code,and an array of
       LDAPControl structures that list the client controls to use with the
       search.  The function also takes an out parameter attribute and if
       the sort operation fails, the server may return a string that
       indicates the first attribute in the sortKey list that caused the
       failure. If this parameter is NULL, no string is returned. If a
       string is returned, the memory should be freed by calling the
       ldap_memfree function.

NOTES         top


SEE ALSO         top

       ldap_result(3), ldap_controls_free(3)

ACKNOWLEDGEMENTS         top

       OpenLDAP Software is developed and maintained by The OpenLDAP Project
       <http://www.openldap.org/>.  OpenLDAP Software is derived from the
       University of Michigan LDAP 3.3 Release.

COLOPHON         top

       This page is part of the OpenLDAP (an open source implementation of
       the Lightweight Directory Access Protocol) project.  Information
       about the project can be found at ⟨http://www.openldap.org/⟩.  If you
       have a bug report for this manual page, see 
       ⟨http://www.openldap.org/its/⟩.  This page was obtained from the
       project's upstream Git repository 
       ⟨git://git.openldap.org/openldap.git⟩ on 2017-09-15.  If you discover
       any rendering problems in this HTML version of the page, or you
       believe there is a better or more up-to-date source for the page, or
       you have corrections or improvements to the information in this
       COLOPHON (which is not part of the original manual page), send a mail
       to man-pages@man7.org

OpenLDAP LDVERSION               RELEASEDATE      LDAP_PARSE_SORT-CONTROL(3)