source: SH_SHM/trunk/help/PROC_CALL.HLP @ 374

Revision 16, 4.6 KB checked in by marcus, 15 years ago (diff)

r1 | svn | 2007-12-13 11:10:29 +0100 (Do, 13 Dez 2007) | 2 lines

Initial import

Line 
1
2call command procedures
3=======================
4
5key: * calling cmd proc's
6
7
8A command procedure is called typing the name of the command file
9without extension.  There can be parameters passed to the command
10procedure which can be referenced from within the procedure by
11"#<parno>", where <parno> is the position number of the parameter.
12Valued or non-valued qualifers can be passed as well.  They can be
13referenced by "#<qualname>", where <qualname> is the name of the
14qualifier.  In the command procedure "#<qualname>" is replaced by
15its value, by "_NOVALUE_" if no value is passed or by "_EXISTSNOT_"
16if the qualifier is not specified.
17
18Example for passing parameters and qualifiers:
19Assume the call of a command procedure CMDPROC as:
20   "CMDPROC/NAME=PETER/TEST LISTFILE TESTPAR"
21Inside the command procedure the following expressions are replaced by:
22   Expression           replaced by
23      #1                LISTFILE
24      #2                TESTPAR
25      #NAME             PETER
26      #TEST             _NOVALUE_
27      #MYQUAL           _EXISTSNOT_
28
29
30
31program control qualifiers
32--------------------------
33
34There are some qualifiers defined which can be passed to
35any command procedure which are interpreted in the following way:
36
37/PARENT
38   Interactive input for the command procedure is read from the
39   parent command level and not from the main input level (main
40   input level is usually the interactive level 0, unless a command
41   procedure is run with the /PLAYBACK qualifier passed).
42
43/CHECK
44   If the command file is not found then no error is produced, the
45   command call is ignored.
46
47/PLAYBACK
48   While this command procedure is active all interactive input is
49   read from this command file (the main input level is set to this
50   command level).  This qualifier is useful if a protocol file is
51   to be run, then all interactive input is recovered from the
52   protocol file and is not prompted again from the user.
53
54/DC=<channels> /IC=<channels> /GC=<channels>
55   Set dialog ("/DC"), info ("/IC") or graphic ("/GC") channels to
56   new values.  <channels> is a character string containing valid
57   channel characters (see below).  These settings are local to
58   the command procedure unless the /GLOBAL or the /MAIN qualifier
59   is specified too.
60
61/DC+=<channels> /IC+=<channels> /GC+=<channels>
62   Add channels to the existing dialog ("/DC+"), info ("/IC+") or
63   graphic ("/GC+") channels.  <channels> is a character string
64   containing valid channel characters (see below).  These settings
65   are local to the command procedure unless the /GLOBAL or the
66   /MAIN qualifier is specified too.
67
68/DC-=<channels> /IC-=<channels> /GC-=<channels>
69   Close channels of the existing dialog ("/DC+"), info ("/IC+") or
70   graphic ("/GC+") channels.  <channels> is a character string
71   containing valid channel characters (see below).  These settings
72   are local to the command procedure unless the /GLOBAL or the
73   /MAIN qualifier is specified too.
74
75/FLAGS=<flags>
76   Set the control flags to new values.  <flags> is a character string
77   containing valid control flag characters (see below).  These
78   settings are local to the command procedure unless the /GLOBAL
79   qualifier is specified too.
80
81/FLAGS+=<flags>
82   Add control flags to the existing ones.  <flags> is a character
83   string containing valid control flag characters (see below).  These
84   settings are local to the command procedure unless the /GLOBAL
85   qualifier is specified too.
86
87/FLAGS-=<flags>
88   Remove control flags from the existing ones.  <flags> is a character
89   string containing valid control flag characters (see below).  These
90   settings are local to the command procedure unless the /GLOBAL
91   qualifier is specified too.
92
93/GLOBAL
94   New settings of the dialog, info and graphic channels and the
95   settings of the control flags are not local to the command
96   procedure but are used for any new created command level.
97
98/MAIN
99   The settings of the dialog, info and graphic channels are changed
100   in the main input level (the current command level is not affected).
101
102
103
104valid channel characters
105------------------------
106
107   "1".."7"   window number (only one window per stream permitted)
108   "H"        hardcopy channel
109   "S"        standard text channel
110   "F"        file
111   "0"        all channels closed
112
113valid control flag characters
114-----------------------------
115
116   "E"        echo all inputs
117   "T"        trace option (prompt after each command)
118   "P"        protocol flag (all inputs are protocolled)
119   "C"        cap conversion (lowercase is converted to uppercase)
120   "V"        verify command (all translated commands are displayed)
121   "X"        abort command procedure on error
122   "A"        abort seismhandler on error
123
Note: See TracBrowser for help on using the repository browser.