1LDAP_PARSE_VLV_CONTROL(3)  Library Functions Manual  LDAP_PARSE_VLV_CONTROL(3)
2
3
4

NAME

6       ldap_parse_vlv_control  - Decode the information returned from a search
7       operation that used a VLV (virtual list view) control
8

LIBRARY

10       OpenLDAP LDAP (libldap, -lldap)
11

SYNOPSIS

13       #include <ldap.h>
14
15       int ldap_parse_vlv_control( ld, ctrlp, target_posp, list_countp, contextp, errcodep )
16       LDAP *ld;
17       LDAPControl **ctrlp;
18       unsigned long *target_posp, *list_countp;
19       struct berval **contextp;
20       int *errcodep;
21

DESCRIPTION

23       The ldap_parse_vlv_control is used to decode the  information  returned
24       from  a search operation that used a VLV (virtual list view)control. It
25       takes a  null  terminated  array  of  LDAPControl  structures,  usually
26       obtained by a call to the ldap_parse_resultfunction, a target_pos which
27       points to the list index of the target  entry.  If  this  parameter  is
28       NULL,  the  target  position  is not returned. The index returned is an
29       approximation of the position of the target entry. It is not guaranteed
30       to  be exact. The parameter list_countp points to the server's estimate
31       of the size of the list. If this parameter is NULL,  the  size  is  not
32       returned.  contextp  is  a pointer to the address of a berval structure
33       that contains a server-generated context identifier if  server  returns
34       one. If server does not return a context identifier, the server returns
35       a NULL in this parameter. If this parameter is set to NULL, the context
36       identifier is not returned. You should use this returned context in the
37       next call to create a VLV control. When  the  berval  structure  is  no
38       longer  needed,  you  should  free the memory by calling the ber_bvfree
39       function.e errcodep is an output parameter, which points to the  result
40       code returned by the server. If this parameter is NULL, the result code
41       is not returned.
42
43       See ldap.h for a list of possible return codes.
44

SEE ALSO

46       ldap_search(3)
47

ACKNOWLEDGEMENTS

49       OpenLDAP Software is developed and maintained by The  OpenLDAP  Project
50       <http://www.openldap.org/>.   OpenLDAP Software is derived from Univer‐
51       sity of Michigan LDAP 3.3 Release.
52
53
54
55OpenLDAP 2.4.23                   2010/06/30         LDAP_PARSE_VLV_CONTROL(3)