← Back to branch summary

~ubuntu-branches/ubuntu/wily/eso-midas/wily-proposed

« back to all changes in this revision

Viewing changes to prim/help/write_erro.mlq

  • Committer: Package Import Robot
  • Author(s): Ole Streicher
  • Date: 2014-04-22 14:44:58 UTC
  • Revision ID: package-import@ubuntu.com-20140422144458-okiwi1assxkkiz39
Tags: upstream-13.09pl1.2+dfsg
Import upstream version 13.09pl1.2+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
prim/help/write_erro.mlq
 
1
% @(#)write_erro.mlq    13.1.1.1 (ESO-IPG) 09/01/98 12:03:53 
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      write_err.mlq
 
5
%.AUTHOR     KB, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, WRITE/ERROR
 
7
%.PURPOSE    On-line help file for the command: WRITE/ERROR
 
8
%.VERSION    1.0  20-FEB-1986 : Creation, KB
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./ERRO
 
12
\es\co
 
13
WRITE/ERROR                                             16-JAN-1999  KB
 
14
\oc\su
 
15
WRITE/ERROR err_spec [message]
 
16
        force an error within a Midas procedure
 
17
\us\pu
 
18
Purpose: 
 
19
           Enforce a Monitor or application error from a Midas procedure.
 
20
\up\sy
 
21
Syntax: 
 
22
           WRITE/ERROR err_spec [message]
 
23
\ys\pa
 
24
           err_spec = errno[,err_source[,display_flag]] with 
 
25
\\
 
26
               errno = error no., err_source = MONITOR or APPLIC,
 
27
\\
 
28
               for APPLIC you can also set display_flag for `message' to 
 
29
               No or Yes (default),
 
30
\\
 
31
               for MONITOR `message' is always displayed;
 
32
\\
 
33
               defaulted to Monitor
 
34
\ap\pa
 
35
           message = optional text string to be displayed
 
36
\ap\sa
 
37
See also:
 
38
           WRITE/OUT, HELP/KEYW PROGSTAT
 
39
\as\no
 
40
Note:  
 
41
           For Monitor errors, the error no. should be > 0;
 
42
\\
 
43
             then it serves as pointer into the relevant section in the 
 
44
             ASCII file MID_MONIT:syserr.dat .
 
45
\\
 
46
             The text in this section is displayed (after display of 
 
47
             `message', if any) and also stored in the keyword MID$ERRMESS. 
 
48
\\
 
49
             If error no. < 0 just the text "Error no. `errno'" is stored
 
50
             in MID$ERRMESS.
 
51
\\
 
52
           For application errors, `message' itself is displayed if the
 
53
              display_flag is set to Yes (default) and always stored
 
54
              in MID$ERRMESS. If no `message' given, it's set to
 
55
              "Error no. `errno'".
 
56
\\
 
57
           The value of `errno' is always stored in keyword PROGSTAT(1)
 
58
\\
 
59
           The procedure containing WRITE/ERROR as well as any procedure 
 
60
           calling this procedure will be aborted.
 
61
\on\exs
 
62
Examples:
 
63
\ex
 
64
           WRITE/ERROR 5 "my error stuff"
 
65
\\
 
66
             This line in a procedure would result in the following output:
 
67
             My error stuff
 
68
             Wrong syntax...
 
69
                                 if you're an expert user, or:
 
70
             My error stuff
 
71
             Wrong syntax... Use the HELP command to verify the command syntax.
 
72
                                 if you're a novice user
 
73
\\
 
74
             because file MID_MONIT:syserr.dat contains:
 
75
             NOVICE.005
 
76
             Wrong syntax... Use the HELP command to verify the command syntax.
 
77
\\
 
78
             The procedure will then terminate and also any procedure calling 
 
79
             this one.
 
80
\\
 
81
             Keword MID$ERRMESS will contain the string:
 
82
             Wrong syntax... Use the HELP command to verify the command syntax.
 
83
\xe\ex
 
84
           WRITE/ERROR 100
 
85
             leads to:
 
86
             Invalid input... The input for this MIDAS command is not correct. 
 
87
             Check the spelling of names, the data format, the file protection,
 
88
             etc.
 
89
             Use the HELP of the command to check out the parameters.
 
90
\\
 
91
             Keword MID$ERRMESS will contain the string:
 
92
             Invalid input... The input for this MIDAS command is not correct.
 
93
\xe\ex
 
94
           WRITE/ERROR 5,app "my error stuff"
 
95
             leads to the display of:
 
96
             My error stuff
 
97
             And also keword MID$ERRMESS will contain the string above.
 
98
\xe\ex
 
99
           WRITE/ERROR 100,app
 
100
             leads to the display of:
 
101
             Error no. 100
 
102
             And also keyword MID$ERRMESS will contain the string above.
 
103
\xe\ex
 
104
           WRITE/ERROR 100,app,no
 
105
             doesn't display anything but stores the message: "Error no. 100"
 
106
             into keyword MID$ERRMESS.
 
107
\xe \sxe