.\"
.\" $XConsortium: p042,v 5.2 94/04/17 20:54:43 rws Exp $
.\"
.\" 
$XMCOPY
.\" Copyright (c) 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
.\" 
.\"                         All Rights Reserved
.\" 
.\" Permission to use, copy, modify, and distribute this software and its 
.\" documentation for any purpose and without fee is hereby granted, 
.\" provided that the above copyright notice appear in all copies and that
.\" both that copyright notice and this permission notice appear in 
.\" supporting documentation, and that the names of Sun Microsystems,
.\" and the X Consortium not be used in advertising or publicity 
.\" pertaining to distribution of the software without specific, written 
.\" prior permission.  
.\" 
.\" SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
.\" INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
.\" EVENT SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
.\" CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
.\" USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
.\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
.\" PERFORMANCE OF THIS SOFTWARE.
.TH "ERROR LOGGING" 3P "29 February 1991"
.SH NAME
ERROR LOGGING \- log \s-2PEX-SI\s0 errors to error file
.IX "Errors" "ERROR LOGGING"
.SH SYNOPSIS
.SS C Syntax
.ft B
.ta 1.25i 3i
.nf
void
perr_log ( errnum, funcnum, fname )
Pint	errnum;	\fIerror number\fP
Pint	funcnum;	\fINumber of function that detected the error\fP
char	*fname;	\fIname of error file\fP
.fi
.ft R
.SS Required PHIGS Operating States
(*, *, *, *)
.SH DESCRIPTION
.SS Purpose
\s-2ERROR LOGGING\s+2 writes an error message and the
identification of the \s-2PHIGS\s+2 function detecting the error to the
\fIerror file\fP.
\s-2ERROR LOGGING\s+2 is always called by the default
\s-2ERROR HANDLING\s+2 function and may also be called by the application.
.SS C Input Parameters
.IP \fIerrnum\fP
The number of the error detected. The error numbers and corresponding error
messages for each function are listed with each function description in
this reference.
.IP \fIfuncnum\fP
The identification of the function which detected the error.
.IP \fIfname\fP
A pointer to the character string containing the name of the error file 
specified in the \s-2OPEN PHIGS\s+2 function.
.SS Execution
\s-2ERROR LOGGING\s+2 writes
the error number, a description of the error, and the
function number of the function that detected the error
to the error file.
.LP
\s-2ERROR LOGGING\s+2 produces error messages of the form:
.sp
.ti +.5i
\s-2PEX-SI\s0 error <\fInumber\fP> in <\fIfunction name\fP>: <\fIerror message text\fP>
.SH ERRORS
.IP 
No Error
.SH SEE ALSO
.nf
.IP
.ta 0.5i
.SM "ERROR HANDLING (3P)"
.SM "SET ERROR HANDLING MODE (3P)"
.SM "OPEN PHIGS (3P)"
.fi