mirror of
https://git.openldap.org/openldap/openldap.git
synced 2025-01-06 10:46:21 +08:00
Added new man page for ldap_parse_sort_control() API
This commit is contained in:
parent
74d54b121a
commit
0098119d2d
44
doc/man/man3/ldap_parse_sort_control.3
Normal file
44
doc/man/man3/ldap_parse_sort_control.3
Normal file
@ -0,0 +1,44 @@
|
||||
.TH LDAP_PARSE_SORT-CONTROL 3 "RELEASEDATE" "OpenLDAP LDVERSION"
|
||||
.\" $OpenLDAP$
|
||||
.\" Copyright 1998-2006 The OpenLDAP Foundation All Rights Reserved.
|
||||
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
|
||||
.SH NAME
|
||||
ldap_parse_sort_control \- Decodes the information returned from a search operation
|
||||
that used a server-side sort control.
|
||||
.SH LIBRARY
|
||||
OpenLDAP LDAP (libldap, -lldap)
|
||||
.SH SYNOPSIS
|
||||
.nf
|
||||
.ft B
|
||||
#include <ldap.h>
|
||||
.LP
|
||||
.ft B
|
||||
int ldap_parse_sort_control(ld, ctrls, returnCode, attribute)
|
||||
.ft
|
||||
LDAP *ld;
|
||||
LDAPControl **ctrls;
|
||||
unsigned long *returnCode;
|
||||
char **attribute;
|
||||
.SH DESCRIPTION
|
||||
This function is used to parse the results returned in a search operation
|
||||
that uses a server-side sort control.
|
||||
.LP
|
||||
It takes a null terminated array of LDAPControl structures usually obtained
|
||||
by a call to the
|
||||
.BR 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 \fIattribute\fP 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.
|
||||
.SH NOTES
|
||||
.SH SEE ALSO
|
||||
.BR ldap_result (3),
|
||||
.BR ldap_controls_free (3)
|
||||
.SH ACKNOWLEDGEMENTS
|
||||
.B OpenLDAP
|
||||
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
|
||||
.B OpenLDAP
|
||||
is derived from University of Michigan LDAP 3.3 Release.
|
Loading…
Reference in New Issue
Block a user