.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "CPANPLUS::Backend::RV 3pm"
.TH CPANPLUS::Backend::RV 3pm "2018-06-25" "perl v5.26.2" "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"
CPANPLUS::Backend::RV \- return value objects
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    ### create a CPANPLUS::Backend::RV object
\&    $backend_rv     = CPANPLUS::Backend::RV\->new(
\&                                ok          => $boolean,
\&                                args        => $args,
\&                                rv          => $return_value
\&                                function    => $calling_function );
\&
\&    ### if you have a CPANPLUS::Backend::RV object
\&    $passed_args    = $backend_rv\->args;    # args passed to function
\&    $ok             = $backend_rv\->ok;      # boolean indication overall
\&                                            # result of the call
\&    $function       = $backend_rv\->function # name of the calling
\&                                            # function
\&    $rv             = $backend_rv\->rv       # the actual return value
\&                                            # of the calling function
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides return value objects for multi-module
calls to CPANPLUS::Backend. In boolean context, it returns the status
of the overall result (ie, the same as the \f(CW\*(C`ok\*(C'\fR method would).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "new( ok => \s-1BOOL,\s0 args => \s-1DATA,\s0 rv => \s-1DATA,\s0 [function => $method_name] )"
.el .SS "new( ok => \s-1BOOL,\s0 args => \s-1DATA,\s0 rv => \s-1DATA,\s0 [function => \f(CW$method_name\fP] )"
.IX Subsection "new( ok => BOOL, args => DATA, rv => DATA, [function => $method_name] )"
Creates a new CPANPLUS::Backend::RV object from the data provided.
This method should only be called by CPANPLUS::Backend functions.
The accessors may be used by users inspecting an \s-1RV\s0 object.
.PP
All the argument names can be used as accessors later to retrieve the
data.
.PP
Arguments:
.IP "ok" 4
.IX Item "ok"
Boolean indicating overall success
.IP "args" 4
.IX Item "args"
The arguments provided to the function that returned this rv object.
Useful to inspect later to see what was actually passed to the function
in case of an error.
.IP "rv" 4
.IX Item "rv"
An arbitrary data structure that has the detailed return values of each
of your multi-module calls.
.IP "function" 4
.IX Item "function"
The name of the function that created this rv object.
Can be explicitly passed. If not, \f(CW\*(C`new()\*(C'\fR will try to deduce the name
from \f(CW\*(C`caller()\*(C'\fR information.
.SH "BUG REPORTS"
.IX Header "BUG REPORTS"
Please report bugs or other issues to <bug\-cpanplus@rt.cpan.org<gt>.
.SH "AUTHOR"
.IX Header "AUTHOR"
This module by Jos Boumans <kane@cpan.org>.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
The \s-1CPAN++\s0 interface (of which this module is a part of) is copyright (c)
2001 \- 2007, Jos Boumans <kane@cpan.org>. All rights reserved.
.PP
This library is free software; you may redistribute and/or modify it
under the same terms as Perl itself.