.\" -*- 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::TreeDelete 3"
.TH Net::LDAP::Control::TreeDelete 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::TreeDelete \- LDAPv3 Tree Delete control object
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use Net::LDAP;
\& use Net::LDAP::Control::TreeDelete;
\&
\& $ldap = Net::LDAP\->new( "ldap.mydomain.eg" );
\&
\& $treedel = Net::LDAP::Control::TreeDelete\->new( critical => 1 );
\&
\& $msg = $ldap\->delete( \*(Aqo=University of Michigan,c=US\*(Aq,
\&                       control  => [ $treedel ] );
\&
\& die "error: ",$msg\->code(),": ",$msg\->error()  if ($msg\->code());
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`Net::LDAP::Control::TreeDelete\*(C'\fR provides an interface for the creation
and manipulation of objects that represent the \f(CW\*(C`TreeDelete\*(C'\fR control as
described by draft\-armijo\-ldap\-treedelete\-02.txt <https://tools.ietf.org/html/draft-armijo-ldap-treedelete-02>
.PP
It allows the client to delete an entire subtree.
.PP
The control is appropriate for LDAP delete operations [RFC4511] only,
and inappropriate for all other operations.
.PP
Its criticality may be TRUE or FALSE; it has no value.
.PP
There is no corresponding response control.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
Since the \f(CW\*(C`TreeDelete\*(C'\fR control does not have any values, only the
constructor arguments described in Net::LDAP::Control are
supported
.SH METHODS
.IX Header "METHODS"
As there are no additional values in the control, only the
methods in Net::LDAP::Control are available for
\&\f(CW\*(C`Net::LDAP::Control::TreeDelete\*(C'\fR objects.
.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.