.\" -*- 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::Extension::Cancel 3" .TH Net::LDAP::Extension::Cancel 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::Extension::Cancel \- LDAP Cancel Operation .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 3 \& use Net::LDAP; \& use Net::LDAP::Constant qw(LDAP_SUCCESS LDAP_CANCELED) \& use Net::LDAP::Extension::Cancel; \& \& $ldap = Net::LDAP\->new( \*(Aqldap.mydomain.eg\*(Aq ); \& \& $ldap\->bind(\*(Aqcn=Joe User,cn=People,dc=example,dc=com\*(Aq, \& password => \*(Aqsecret\*(Aq); \& \& $search = $ldap\->search( \& base => \*(Aqc=US\*(Aq, \& filter => \*(Aq(&(sn=Barr) (o=Texas Instruments))\*(Aq, \& callback => \e&process_entry, # Call this sub for each entry \& ); \& \& $mesg = $ldap\->cancel($search); \& \& die "error :", $mesg\->code(), ": ", $mesg\->error() \& if ($mesg\->code() != LDAP_CANCELED && mesg\->code() != LDAP_SUCCESS); .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" \&\f(CW\*(C`Net::LDAP::Extension::Cancel\*(C'\fR implements the \f(CW\*(C`Cancel\*(C'\fR extended LDAPv3 operation as described in RFC 3909. .PP The \f(CW\*(C`Cancel\*(C'\fR extended operation is very similar to the \f(CW\*(C`Abandon\*(C'\fR standard operation, and has the same call signature. Unlike the \f(CW\*(C`Abandon\*(C'\fR operation, it has a response which provides an indication of its outcome. .PP It implements no object by itself but extends the Net::LDAP object by another method: .SH METHODS .IX Header "METHODS" .IP "cancel ( OPERATION, OPTIONS )" 4 .IX Item "cancel ( OPERATION, OPTIONS )" Cancel an outstanding operation. \f(CW\*(C`OPERATION\*(C'\fR may be a number or an object which is a sub-class of Net::LDAP::Message, returned from a previous method call. .Sp OPTIONS is a list of key/value pairs. The following keys are recognized: .RS 4 .IP "control => CONTROL" 4 .IX Item "control => CONTROL" .PD 0 .IP "control => [ CONTROL, .. ]" 4 .IX Item "control => [ CONTROL, .. ]" .PD Control(s) to be passed to the operation. .RE .RS 4 .RE .SH "SEE ALSO" .IX Header "SEE ALSO" Net::LDAP, Net::LDAP::Extension .SH AUTHOR .IX Header "AUTHOR" Peter Marschall . .PP Please report any bugs, or post any suggestions, to the perl-ldap mailing list .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (c) 2011 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.