.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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
..
.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 "CPANPLUS::Error 3pm"
.TH CPANPLUS::Error 3pm "2021-11-24" "perl v5.32.1" "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::Error \- error handling for CPANPLUS
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use CPANPLUS::Error qw[cp_msg cp_error];
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides the error handling code for the \s-1CPANPLUS\s0
libraries, and is mainly intended for internal use.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.ie n .SS "cp_msg(""message string"" [,VERBOSE])"
.el .SS "cp_msg(``message string'' [,VERBOSE])"
.IX Subsection "cp_msg(message string [,VERBOSE])"
Records a message on the stack, and prints it to \f(CW\*(C`STDOUT\*(C'\fR (or actually
\&\f(CW$MSG_FH\fR, see the \f(CW\*(C`GLOBAL VARIABLES\*(C'\fR section below), if the
\&\f(CW\*(C`VERBOSE\*(C'\fR option is true.
The \f(CW\*(C`VERBOSE\*(C'\fR option defaults to false.
.SS "\fBmsg()\fP"
.IX Subsection "msg()"
An alias for \f(CW\*(C`cp_msg\*(C'\fR.
.ie n .SS "cp_error(""error string"" [,VERBOSE])"
.el .SS "cp_error(``error string'' [,VERBOSE])"
.IX Subsection "cp_error(error string [,VERBOSE])"
Records an error on the stack, and prints it to \f(CW\*(C`STDERR\*(C'\fR (or actually
\&\f(CW$ERROR_FH\fR, see the \f(CW\*(C`GLOBAL VARIABLES\*(C'\fR sections below), if the
\&\f(CW\*(C`VERBOSE\*(C'\fR option is true.
The \f(CW\*(C`VERBOSE\*(C'\fR options defaults to true.
.SS "\fBerror()\fP"
.IX Subsection "error()"
An alias for \f(CW\*(C`cp_error\*(C'\fR.
.SH "CLASS METHODS"
.IX Header "CLASS METHODS"
.SS "CPANPLUS::Error\->\fBstack()\fP"
.IX Subsection "CPANPLUS::Error->stack()"
Retrieves all the items on the stack. Since \f(CW\*(C`CPANPLUS::Error\*(C'\fR is
implemented using \f(CW\*(C`Log::Message\*(C'\fR, consult its manpage for the
function \f(CW\*(C`retrieve\*(C'\fR to see what is returned and how to use the items.
.SS "CPANPLUS::Error\->stack_as_string([\s-1TRACE\s0])"
.IX Subsection "CPANPLUS::Error->stack_as_string([TRACE])"
Returns the whole stack as a printable string. If the \f(CW\*(C`TRACE\*(C'\fR option is
true all items are returned with \f(CW\*(C`Carp::longmess\*(C'\fR output, rather than
just the message.
\&\f(CW\*(C`TRACE\*(C'\fR defaults to false.
.SS "CPANPLUS::Error\->\fBflush()\fP"
.IX Subsection "CPANPLUS::Error->flush()"
Removes all the items from the stack and returns them. Since
\&\f(CW\*(C`CPANPLUS::Error\*(C'\fR is  implemented using \f(CW\*(C`Log::Message\*(C'\fR, consult its
manpage for the function \f(CW\*(C`retrieve\*(C'\fR to see what is returned and how
to use the items.
.SH "GLOBAL VARIABLES"
.IX Header "GLOBAL VARIABLES"
.ie n .IP "$ERROR_FH" 4
.el .IP "\f(CW$ERROR_FH\fR" 4
.IX Item "$ERROR_FH"
This is the filehandle all the messages sent to \f(CW\*(C`error()\*(C'\fR are being
printed. This defaults to \f(CW*STDERR\fR.
.ie n .IP "$MSG_FH" 4
.el .IP "\f(CW$MSG_FH\fR" 4
.IX Item "$MSG_FH"
This is the filehandle all the messages sent to \f(CW\*(C`msg()\*(C'\fR are being
printed. This default to \f(CW*STDOUT\fR.