1SETER(3NCARG)                    NCAR GRAPHICS                   SETER(3NCARG)
2
3
4

NAME

6       SETER - Called by NCAR Graphics routines when errors occur.
7

SYNOPSIS

9       CALL SETER(MESSG,NERRF,ILEVL)
10

C-BINDING SYNOPSIS

12       #include <ncarg/ncargC.h>
13
14       void c_seter(char *messg, int nerrf, int ilevl)
15

DESCRIPTION

17       The FORTRAN statement "CALL SETER (MESSG,NERRF,ILEVL) is used to tell
18       the error-handling package that an error has occurred. Exactly what
19       happens as a result of such a call depends not only on the values of
20       the arguments, but on the settings of two internal variables: the error
21       flag, which says whether or not there was a prior error, and the
22       recovery-mode flag, which says whether or not recovery mode is in
23       effect.
24
25        -  If the internal error flag is 0 (no prior error) and the internal
26           recovery-mode flag is 2 (recovery mode not set, which is the
27           default), SETER prints the error message MESSG, calls FDUM if and
28           only if ILEVL = 2, and then STOPs.
29
30        -  If the internal error flag is 0 (no prior error) and the internal
31           recovery-mode flag is 1 (recovery mode set), then what happens
32           depends on the value of ILEVL: if ILEVL = 2 (fatal error), SETER
33           prints the error message MESSG, calls FDUM, and STOPs, but, if
34           ILEVL = 1 (recoverable error), SETER resets the internal error flag
35           equal to NERRF, remembers the error message MESSG, and RETURNs. In
36           the latter case, the user is expected to detect the fact that an
37           error has occurred, take the necessary remedial action, and call
38           ERROF to turn the internal error flag off.
39
40        -  If the internal error flag is non-zero (prior error), then the
41           value of the internal recovery-mode flag will be 1 (recovery mode
42           set); in this case, it doesn't make any difference what the value
43           of ILEVL is: SETER prints both the remembered error message from
44           the prior error and the new error message from MESSG, calls FDUM,
45           and STOPs.
46
47       The arguments of SETER are as follows:
48
49
50       MESSG       (an input variable or constant of type CHARACTER) is an
51                   error message describing the error that has occurred. This
52                   should be of the form "XXXXXX - TEXT DESCRIBING THE ERROR",
53                   where "XXXXXX" is the name of the routine in which the
54                   error occurred, and it should not be more than 113
55                   characters long.
56
57       NERRF       (an input expression of type INTEGER) is a non-zero error
58                   number in the range from -999 to +9999.
59
60       ILEVL       (an input expression of type INTEGER) is the "error level"
61                   - either a 1 or a 2, implying that the error described by
62                   MESSG and NERRF is recoverable or fatal, respectively.
63

C-BINDING DESCRIPTION

65       The C-binding argument descriptions are the same as the FORTRAN
66       argument descriptions.
67

EXAMPLES

69       Use the ncargex command to see the following relevant examples: tseter,
70       arex02.
71

ACCESS

73       To use SETER or c_seter, load the NCAR Graphics libraries ncarg,
74       ncarg_gks, and ncarg_c, preferably in that order.
75

SEE ALSO

77       Online: entsr, eprin, errof, error_handling, fdum, icfell, icloem,
78       nerro, retsr, semess, ncarg_cbind
79
81       Copyright (C) 1987-2007
82       University Corporation for Atmospheric Research
83
84       This documentation is free software; you can redistribute it and/or
85       modify it under the terms of the GNU General Public License as
86       published by the Free Software Foundation; either version 2 of the
87       License, or (at your option) any later version.
88
89       This software is distributed in the hope that it will be useful, but
90       WITHOUT ANY WARRANTY; without even the implied warranty of
91       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
92       General Public License for more details.
93
94       You should have received a copy of the GNU General Public License along
95       with this software; if not, write to the Free Software Foundation,
96       Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
97
98
99
100UNIX                              March 1994                     SETER(3NCARG)
Impressum