git.sur5r.net Git - openldap/blob - doc/man/man3/ldap_parse_vlv_control.3

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