DramaLoad - Load a program using the Drama system.
Function
Load a program using the Drama system.
Description
Loads and runs a task using the Drama load system. For full
details you should see the description of the DitsLoad() routine,
to which this Tcl command provides an interface.
Note, prior to Tk 4.1, this command was named "load".
Call
DramaLoad program [options]
Parameters
> | program | string | The name of the program to run. See DitsLoad()
documtation for full details of this
specification
|
---|
|
Options
- -wait
- Wait until the load has completed
before returning.
- -complete command
- Execute "command" when the load completes.
(Only one of -wait or -complete can be used).
- -waitload
- Wait but only until the load completes and
the task has registered. Will return on first
off - task registering, task load failure or
task exiting.
- -loaded command
- Execute "command" when the load completes
succesfully. The command will be appended
with three arguments, the program name as
supplied above, the node on which the program
was loaded and the task name the program has
registered as.
- -failure command
- Execute "command" if the load fails. The
command will be appended with five arguments,
the program name as supplied above, the node
on which the program load was attempted, the
dits error code translation, the target node
error code and the dits error code as an integer.
- -exit command
- Execute "command" when the loaded program exits.
The command will be appended with three
arguments, the program name as supplied above,
the node on which the program was loaded and
the text of the target node error code which
the program returned. This will be the string
OK if the program completed successfully.
- -node name
- The node on which the program should be loaded.
If not supplied, use the current node.
- -argument string
- Arguments to the loaded program
- -process name
- The process name to be given the the program
- -decode string
- Argument decode string.
- -bytes integer
- The number of bytes to allocated for the program.
- -priority integer
- The requested priority for the program
- -timeout integer
- Load timeout value
- -split
- Split arguments using decode string
- -relprio
- Priority is relative to parent
- -absprio
- Priority is absolute
- -symbol
- For VMS target, name is a symbol
- -prog
- For VMS target, name is a program name
- -names
- For VMS target, inherit logical names and
symbols. For Unix target, inherit environment.
- -noflush
- If an error is signalled immediately, then
don't flush errors reported with Ers. This
gives the caller (say catch) control over error
output using ErsFlush and ErsAnnul. By default,
errors will be flushed.
Language
Tcl
See Also
DTCL manual, DitsLoad(3), Dits manual, Imp manual.
Support
Tony Farrell, AAO
Click here for the DRAMA home page and
here for the AAO home page.
For more information, contact tony.farrell@mq.edu.au