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