external/bsd/openldap/man/ldap_parse_sort_control.3

   1 .TH LDAP_PARSE_SORT-CONTROL 3 "2008/07/16" "OpenLDAP 2.4.11"
   2 .\" $OpenLDAP: pkg/ldap/doc/man/man3/ldap_parse_sort_control.3,v 1.1.2.3 2008/02/11 23:26:39 kurt Exp $
   3 .\" Copyright 1998-2008 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 ldap_parse_sort_control \- Decode the information returned from a search operation that used a server-side sort control
   7 .SH LIBRARY
   8 OpenLDAP LDAP (libldap, -lldap)
   9 .SH SYNOPSIS
  10 .nf
  11 .ft B
  12 #include <ldap.h>
  13 .LP
  14 .ft B
  15 int ldap_parse_sort_control(ld, ctrls, returnCode, attribute)
  16 .ft
  17 LDAP *ld;
  18 LDAPControl **ctrls;
  19 unsigned long *returnCode;
  20 char **attribute;
  21 .SH DESCRIPTION
  22 This function is used to parse the results returned in a search operation
  23 that uses a server-side sort control.
  24 .LP
  25 It takes a null terminated array of LDAPControl structures usually obtained
  26 by a call to the
  27 .BR ldap_parse_result
  28 function. A returncode which points to the sort control result code,and an array
  29 of LDAPControl structures that list the client controls to use with the search.
  30 The function also takes an out parameter \fIattribute\fP and if the sort operation
  31 fails, the server may return a string that indicates the first attribute in the
  32 sortKey list that caused the failure. If this parameter is NULL, no string is
  33 returned. If a string is returned, the memory should be freed by calling the
  34 ldap_memfree function.
  35 .SH NOTES
  36 .SH SEE ALSO
  37 .BR ldap_result (3),
  38 .BR ldap_controls_free (3)
  39 .SH ACKNOWLEDGEMENTS
  40 .\" Shared Project Acknowledgement Text
  41 .B "OpenLDAP Software"
  42 is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
  43 .B "OpenLDAP Software"
  44 is derived from University of Michigan LDAP 3.3 Release.