Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
LDAP_PARSE_SORT-CONTROL(3) Library Functions Manual LDAP_PARSE_SORT-CONTROL(3)

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

LIBRARY
       OpenLDAP	LDAP (libldap, -lldap)

SYNOPSIS
       #include	<ldap.h>

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

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

       It takes	a null terminated array	of LDAPControl structures usually  ob-
       tained  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	opera-
       tion fails, the server may return a string that indicates the first at-
       tribute	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
SEE ALSO
       ldap_result(3), ldap_controls_free(3)

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

OpenLDAP 2.6.9			  2024/11/26	    LDAP_PARSE_SORT-CONTROL(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ldap_parse_sort_control&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help