1CPANPLUS::Backend::RV(3U)ser Contributed Perl DocumentatiCoPnANPLUS::Backend::RV(3)
2
3
4

NAME

6       CPANPLUS::Backend::RV
7

SYNOPSIS

9           ### create a CPANPLUS::Backend::RV object
10           $backend_rv     = CPANPLUS::Backend::RV->new(
11                                       ok          => $boolean,
12                                       args        => $args,
13                                       rv          => $return_value
14                                       function    => $calling_function );
15
16           ### if you have a CPANPLUS::Backend::RV object
17           $passed_args    = $backend_rv->args;    # args passed to function
18           $ok             = $backend_rv->ok;      # boolean indication overall
19                                                   # result of the call
20           $function       = $backend_rv->fucntion # name of the calling
21                                                   # function
22           $rv             = $backend_rv->rv       # the actual return value
23                                                   # of the calling function
24

DESCRIPTION

26       This module provides return value objects for multi-module calls to
27       CPANPLUS::Backend. In boolean context, it returns the status of the
28       overall result (ie, the same as the "ok" method would).
29

METHODS

31       new( ok => BOOL, args => DATA, rv => DATA, [function => $method_name] )
32
33       Creates a new CPANPLUS::Backend::RV object from the data provided.
34       This method should only be called by CPANPLUS::Backend functions.  The
35       accessors may be used by users inspecting an RV object.
36
37       All the argument names can be used as accessors later to retrieve the
38       data.
39
40       Arguments:
41
42       ok  Boolean indicating overall success
43
44       args
45           The arguments provided to the function that returned this rv
46           object.  Useful to inspect later to see what was actually passed to
47           the function in case of an error.
48
49       rv  An arbitrary data structure that has the detailed return values of
50           each of your multi-module calls.
51
52       function
53           The name of the function that created this rv object.  Can be
54           explicitly passed. If not, "new()" will try to deduce the name from
55           "caller()" information.
56

BUG REPORTS

58       Please report bugs or other issues to <bug-cpanplus@rt.cpan.org<gt>.
59

AUTHOR

61       This module by Jos Boumans <kane@cpan.org>.
62

64       The CPAN++ interface (of which this module is a part of) is copyright
65       (c) 2001 - 2007, Jos Boumans <kane@cpan.org>. All rights reserved.
66
67       This library is free software; you may redistribute and/or modify it
68       under the same terms as Perl itself.
69
70
71
72perl v5.8.8                       2007-03-31          CPANPLUS::Backend::RV(3)
Impressum