git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_parse_sort_control.3

   1 .TH LDAP_PARSE_SORT-CONTROL 3 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_parse_sort_control \- Decodes the information returned from a search operation
   7 that used a server-side sort control.
   8 .SH LIBRARY
   9 OpenLDAP LDAP (libldap, -lldap)
  10 .SH SYNOPSIS
  11 .nf
  12 .ft B
  13 #include <ldap.h>
  14 .LP
  15 .ft B
  16 int ldap_parse_sort_control(ld, ctrls, returnCode, attribute)
  17 .ft
  18 LDAP *ld;
  19 LDAPControl **ctrls;
  20 unsigned long *returnCode;
  21 char **attribute;
  22 .SH DESCRIPTION
  23 This function is used to parse the results returned in a search operation
  24 that uses a server-side sort control.
  25 .LP
  26 It takes a null terminated array of LDAPControl structures usually obtained
  27 by a call to the
  28 .BR ldap_parse_result
  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.
  36 .SH NOTES
  37 .SH SEE ALSO
  38 .BR ldap_result (3),
  39 .BR ldap_controls_free (3)
  40 .SH ACKNOWLEDGEMENTS
  41 .B OpenLDAP
  42 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
  43 .B OpenLDAP
  44 is derived from University of Michigan LDAP 3.3 Release.