1 .TH LDAP_PARSE_SORT-CONTROL 3 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
4 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 ldap_parse_sort_control \- Decodes the information returned from a search operation
7 that used a server-side sort control.
9 OpenLDAP LDAP (libldap, -lldap)
16 int ldap_parse_sort_control(ld, ctrls, returnCode, attribute)
20 unsigned long *returnCode;
23 This function is used to parse the results returned in a search operation
24 that uses a server-side sort control.
26 It takes a null terminated array of LDAPControl structures usually obtained
29 function. A returncode which points to the sort control result code,and an array
30 of LDAPControl structures that list the client controls to use with the search.
31 The function also takes an out parameter \fIattribute\fP and if the sort operation
32 fails, the server may return a string that indicates the first attribute in the
33 sortKey list that caused the failure. If this parameter is NULL, no string is
34 returned. If a string is returned, the memory should be freed by calling the
35 ldap_memfree function.
39 .BR ldap_controls_free (3)