1.lf 1 stdin
2.TH LDAP_PARSE_VLV_CONTROL 3 "2020/04/28" "OpenLDAP 2.4.50"
3.\" $OpenLDAP$
4.\" Copyright 1998-2020 The OpenLDAP Foundation All Rights Reserved.
5.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
6.SH NAME
7ldap_parse_vlv_control \- Decode the information returned from a search operation that used a VLV (virtual list view) control
8.SH LIBRARY
9OpenLDAP LDAP (libldap, \-lldap)
10.SH SYNOPSIS
11.nf
12.ft B
13#include <ldap.h>
14.LP
15.ft B
16int ldap_parse_vlv_control( ld, ctrlp, target_posp, list_countp, contextp, errcodep )
17.ft
18LDAP *ld;
19LDAPControl **ctrlp;
20unsigned long *target_posp, *list_countp;
21struct berval **contextp;
22int *errcodep;
23.SH DESCRIPTION
24The
25.B ldap_parse_vlv_control
26is used to decode the information returned from a search operation that used a
27VLV (virtual list view)control. It takes a null terminated array of LDAPControl
28structures, usually obtained by a call to the 
29.BR ldap_parse_result function,
30a \fItarget_pos\fP which points to the list index of the target entry. If
31this parameter is NULL, the target position is not returned. The index returned 
32is an approximation of the position of the target entry. It is
33not guaranteed to be exact. The parameter \fIlist_countp\fP points to 
34the server's estimate of the size of the list. If this parameter is NULL, the
35size is not returned. \fIcontextp\fP is a pointer to the address of a berval
36structure that contains a server-generated context identifier if server returns
37one. If server does not return a context identifier, the server returns a NULL
38in this parameter. If this parameter is set to NULL, the context identifier is
39not returned. You should use this returned context in the next call to
40create a VLV control. When the berval structure is no longer needed, you should
41free the memory by calling the \fIber_bvfree function.e\fP
42\fIerrcodep\fP is an output parameter, which points to the result code returned
43by the server. If this parameter is NULL, the result code is not returned.
44.LP 
45See
46ldap.h for a list of possible return codes.
47.SH SEE ALSO
48.BR ldap_search (3)
49.SH ACKNOWLEDGEMENTS
50.lf 1 ./../Project
51.\" Shared Project Acknowledgement Text
52.B "OpenLDAP Software"
53is developed and maintained by The OpenLDAP Project <http://www.openldap.org/>.
54.B "OpenLDAP Software"
55is derived from the University of Michigan LDAP 3.3 Release.  
56.lf 50 stdin
57