modified: diffout.py
[GalaxyCodeBases.git] / c_cpp / etc / calc / help / error
blob6f457297fb3a42785933efe7e74a55c543894c05
1 NAME
2     error - generate a value of specified error type
4 SYNOPSIS
5     error([n])
7 TYPES
8     n           integer, 0 <= n <= 32767; defaults to errno()
10     return      null value or error value
12 DESCRIPTION
14     If n is zero,  error(n) returns the null value.
16     For positive n, error(n) returns a value of error type n.
18     error(n) sets calc_errno to n so that until another error-value
19     is returned by some function, errno() will return the value n.
21 EXAMPLE
22     ; errmax(errcount()+1)
23            20
24     ; a = error(10009)
25     ; a
26            Error 10009
27     ; strerror(a)
28            "Bad argument for inverse"
30 LIMITS
31     none
33 LINK LIBRARY
34     none
36 SEE ALSO
37     errcount, errmax, errorcodes, iserror, errno, strerror, newerror,
38     stoponerror
40 ## Copyright (C) 1999-2006  Landon Curt Noll
42 ## Calc is open software; you can redistribute it and/or modify it under
43 ## the terms of the version 2.1 of the GNU Lesser General Public License
44 ## as published by the Free Software Foundation.
46 ## Calc is distributed in the hope that it will be useful, but WITHOUT
47 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
48 ## or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General
49 ## Public License for more details.
51 ## A copy of version 2.1 of the GNU Lesser General Public License is
52 ## distributed with calc under the filename COPYING-LGPL.  You should have
53 ## received a copy with calc; if not, write to Free Software Foundation, Inc.
54 ## 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
56 ## @(#) $Revision: 30.1 $
57 ## @(#) $Id: error,v 30.1 2007/03/16 11:10:42 chongo Exp $
58 ## @(#) $Source: /usr/local/src/cmd/calc/help/RCS/error,v $
60 ## Under source code control:   1995/12/18 03:30:59
61 ## File existed as early as:    1995
63 ## chongo <was here> /\oo/\     http://www.isthe.com/chongo/
64 ## Share and enjoy!  :-)        http://www.isthe.com/chongo/tech/comp/calc/