.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "CGI::Session::ErrorHandler 3"
.TH CGI::Session::ErrorHandler 3 2023-07-25 "perl v5.38.0" "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
CGI::Session::ErrorHandler \- error handling routines for CGI::Session
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    require CGI::Session::ErrorHandler;
\&    @ISA = qw( CGI::Session::ErrorHandler );
\&
\&    sub some_method {
\&        my $self = shift;
\&        unless (  $some_condition ) {
\&            return $self\->set_error("some_method(): \e$some_condition isn\*(Aqt met");
\&        }
\&    }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
CGI::Session::ErrorHandler provides \fBset_error()\fR and \fBerrstr()\fR methods for setting and accessing error messages from within CGI::Session's components. This method should be used by driver developers for providing CGI::Session\-standard error handling routines for their code
.SS METHODS
.IX Subsection "METHODS"
.IP set_error($message) 4
.IX Item "set_error($message)"
Implicitly defines \f(CW$pkg_name::errstr\fR and sets its value to \f(CW$message\fR. Return value is \fBalways\fR undef.
.IP \fBerrstr()\fR 4
.IX Item "errstr()"
Returns whatever value was set by the most recent call to \fBset_error()\fR. If no message as has been set yet, the empty string is returned so the message can still concatenate without a warning.
.SH LICENSING
.IX Header "LICENSING"
For support and licensing information see CGI::Session.