.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::LDAP::Control::VLVResponse 3"
.TH Net::LDAP::Control::VLVResponse 3 "2021-01-03" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::LDAP::Control::VLVResponse \-\- LDAPv3 Virtual List View server response
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See Net::LDAP::Control::VLV
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Control::VLVResponse\*(C'\fR is a sub-class of Net::LDAP::Control.
It provides a class for manipulating the \s-1LDAP\s0 Virtual List View Response control
\&\f(CW\*(C`\*(C'\fR
.PP
If the server supports Virtual List Views, then the response from a search operation will
include a VLVResponse control.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
In addition to the constructor arguments described in
Net::LDAP::Control the following are provided.
.IP "content" 4
.IX Item "content"
An estimate of the number of entries in the complete list. This value should
be used in any subsequent Virtual List View control using the same list.
.IP "context" 4
.IX Item "context"
An arbitrary value which is used to associate subsequent requests with the
request which this control is a response for. This value should be copied
by the client into the Virtual List View control for any subsequent
search that uses the same list.
.IP "result" 4
.IX Item "result"
A result code indicating the result of the Virtual List View request. This
may be any of the codes listed below.
.IP "target" 4
.IX Item "target"
The list offset of the target entry.
.SH "METHODS"
.IX Header "METHODS"
As with Net::LDAP::Control each constructor argument
described above is also available as a method on the object which will
return the current value for the attribute if called without an argument,
and set a new value for the attribute if called with an argument.
.SH "RESULT CODES"
.IX Header "RESULT CODES"
Possible results from a sort request are listed below. See Net::LDAP::Constant for
a definition of each.
.IP "\s-1LDAP_SUCCESS\s0" 4
.IX Item "LDAP_SUCCESS"
.PD 0
.IP "\s-1LDAP_OPERATIONS_ERROR\s0" 4
.IX Item "LDAP_OPERATIONS_ERROR"
.IP "\s-1LDAP_TIMELIMIT_EXCEEDED\s0" 4
.IX Item "LDAP_TIMELIMIT_EXCEEDED"
.IP "\s-1LDAP_ADMIN_LIMIT_EXCEEDED\s0" 4
.IX Item "LDAP_ADMIN_LIMIT_EXCEEDED"
.IP "\s-1LDAP_INSUFFICIENT_ACCESS\s0" 4
.IX Item "LDAP_INSUFFICIENT_ACCESS"
.IP "\s-1LDAP_BUSY\s0" 4
.IX Item "LDAP_BUSY"
.IP "\s-1LDAP_UNWILLING_TO_PERFORM\s0" 4
.IX Item "LDAP_UNWILLING_TO_PERFORM"
.IP "\s-1LDAP_OTHER\s0" 4
.IX Item "LDAP_OTHER"
.IP "\s-1LDAP_SORT_CONTROL_MISSING\s0" 4
.IX Item "LDAP_SORT_CONTROL_MISSING"
.IP "\s-1LDAP_INDEX_RANGE_ERROR\s0" 4
.IX Item "LDAP_INDEX_RANGE_ERROR"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Net::LDAP::Control
.SH "AUTHOR"
.IX Header "AUTHOR"
Graham Barr <gbarr@pobox.com>
.PP
Please report any bugs, or post any suggestions, to the perl-ldap mailing list
<perl\-ldap@perl.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2000\-2004 Graham Barr. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.