GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CPANPLUS::ERROR (3)

.ds Aq ’

NAME

CPANPLUS::Error - error handling for CPANPLUS

CONTENTS

SYNOPSIS



    use CPANPLUS::Error qw[cp_msg cp_error];



DESCRIPTION

This module provides the error handling code for the CPANPLUS libraries, and is mainly intended for internal use.

FUNCTIONS

    cp_msg(‘‘message string’’ [,VERBOSE])

Records a message on the stack, and prints it to STDOUT (or actually $MSG_FH, see the GLOBAL VARIABLES section below), if the VERBOSE option is true. The VERBOSE option defaults to false.

msg()

An alias for cp_msg.

    cp_error(‘‘error string’’ [,VERBOSE])

Records an error on the stack, and prints it to STDERR (or actually $ERROR_FH, see the GLOBAL VARIABLES sections below), if the VERBOSE option is true. The VERBOSE options defaults to true.

error()

An alias for cp_error.

CLASS METHODS

CPANPLUS::Error->stack()

Retrieves all the items on the stack. Since CPANPLUS::Error is implemented using Log::Message, consult its manpage for the function retrieve to see what is returned and how to use the items.

    CPANPLUS::Error->stack_as_string([TRACE])

Returns the whole stack as a printable string. If the TRACE option is true all items are returned with Carp::longmess output, rather than just the message. TRACE defaults to false.

CPANPLUS::Error->flush()

Removes all the items from the stack and returns them. Since CPANPLUS::Error is implemented using Log::Message, consult its manpage for the function retrieve to see what is returned and how to use the items.

GLOBAL VARIABLES

$ERROR_FH This is the filehandle all the messages sent to error() are being printed. This defaults to *STDERR.
$MSG_FH This is the filehandle all the messages sent to msg() are being printed. This default to *STDOUT.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 CPANPLUS::ERROR (3) 2015-10-15

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.