Changeset 3927

Timestamp:

May 13, 2005, 11:48:05 AM (21 years ago)

Author:

Paul Price

Message:

Adding function name to psError to sync with devel.

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.214 2005-05-13 21:38:44 price Exp $
+%%% $Id: psLibSDRS.tex,v 1.215 2005-05-13 21:48:05 price Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -1046 +1046 @@
 returns the error code.
 \begin{verbatim}
-psErrorCode p_psError(const char *file, int lineno, psErrorCode code, bool new, const char *fmt, ...);
-#define psError(code, new, fmt, ...) psError(__FILE__, __LINE__, code, new, fmt, __VA_ARGS__)
-\end{verbatim}
-
-\code{psError} is a macro definition that allows the function and line
-number to be inputted to a private function, \code{p_psError}.  The
-\code{code} is an enumerated type which lists the possible
-\textit{classes} of errors (e.g. \code{PS_ERR_IO}) that \PS{} code can
-generate (see section \ref{psErrorCodes}). The \code{new} argument
-takes a boolean which, if \code{TRUE} specifies that the error was set
-initially at this location, and if \code{FALSE} specifies that an
-error was passed to this location.  Raising new error should clear the
-error stack.  The final required argument, \code{fmt}, is a
-\code{printf}-style format that is passed to \code{psLogMsgV} with
-code \code{PS_LOG_ERROR}, and component equal to the concatenation of
-the file name and the line number, separated by a colon.  The result
-of a call to \code{psError} must be to push an error onto a stack;
-this stack is cleared if \code{new} is true, or by a call to
-\code{psErrorClear}.
+psErrorCode p_psError(const char *file, int lineno, const char *func, psErrorCode code, bool new,
+                      const char *fmt, ...);
+#define psError(code, new, fmt, ...) psError(__FILE__, __LINE__, __func__, code, new, fmt, __VA_ARGS__)
+\end{verbatim}
+
+\code{psError} is a macro definition that allows the filename, line
+number and function name to be inputted to a private function,
+\code{p_psError}.  The \code{code} is an enumerated type which lists
+the possible \textit{classes} of errors (e.g. \code{PS_ERR_IO}) that
+\PS{} code can generate (see section \ref{psErrorCodes}). The
+\code{new} argument takes a boolean which, if \code{TRUE} specifies
+that the error was set initially at this location, and if \code{FALSE}
+specifies that an error was passed to this location.  Raising new
+error should clear the error stack.  The final required argument,
+\code{fmt}, is a \code{printf}-style format that is passed to
+\code{psLogMsgV} with code \code{PS_LOG_ERROR}, and component equal to
+the concatenation of the file name and the line number, separated by a
+colon.  The result of a call to \code{psError} must be to push an
+error onto a stack; this stack is cleared if \code{new} is true, or by
+a call to \code{psErrorClear}.
 
 The errors on the error stack are defined as the following: