.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" 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" '' '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 turned on, 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. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::LDAP::Extension::Cancel 3" .TH Net::LDAP::Extension::Cancel 3 "2015-04-02" "perl v5.12.5" "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 \s-1RFC\s0 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 ( \s-1OPERATION\s0, \s-1OPTIONS\s0 )" 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 \&\s-1OPTIONS\s0 is a list of key/value pairs. The following keys are recognized: .RS 4 .IP "control => \s-1CONTROL\s0" 4 .IX Item "control => CONTROL" .PD 0 .IP "control => [ \s-1CONTROL\s0, .. ]" 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.