.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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::Subentries 3"
.TH Net::LDAP::Control::Subentries 3 2024-09-01 "perl v5.40.0" "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::Subentries \- LDAPv3 Subentries control object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use Net::LDAP;
\& use Net::LDAP::Control::Subentries;
\&
\& $ldap = Net::LDAP\->new( "ldap.mydomain.eg" );
\&
\& $subentries = Net::LDAP::Control::Subentries\->new( visibility => 1 );
\&
\& $msg = $ldap\->search( base => \*(Aqdc=sub,dc=mydomain,dc=eg",
\&                       filter => \*(Aq(objectclass=*)\*(Aq,
\&                       attrs => [ qw/1.1/ ],
\&                       control => [ $subentries ] );
\&
\& die "error: ",$msg\->code(),": ",$msg\->error()  if ($msg\->code());
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Control::Subentries\*(C'\fR provides an interface for the creation
and manipulation of objects that represent the \f(CW\*(C`Subentries\*(C'\fR control as
described by RFC 3672.
.PP
This control, for which no corresponding response control exists, is
appropriate for LDAP search operations only.
.PP
In absence of this control, subentries are visible only to
LDAP search requests with \f(CW\*(C`scope => \*(Aqbase\*(Aq\*(C'\fR,
but not to searches with any other \f(CW\*(C`scope\*(C'\fR value.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
In addition to the constructor arguments described in
Net::LDAP::Control the following are provided:
.IP visibility 4
.IX Item "visibility"
A Boolean value indicating the visibility of subentries or regular entries.
.Sp
The value \f(CW\*(C`TRUE\*(C'\fR indicates that subentries are visible and normal entries
are not; the value \f(CW\*(C`FALSE\*(C'\fR indicates that normal entries are visible
and subentries are not.
.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 "SEE ALSO"
.IX Header "SEE ALSO"
Net::LDAP,
Net::LDAP::Control,
.SH AUTHOR
.IX Header "AUTHOR"
Peter Marschall <peter@adpm.de>.
.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) 2020 Peter Marschall. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.