Class Documentation

Name:Run
Version:1.0
ID:ID_RUN
Status:Unspecified
Category:Command
Date:June 2001
Author:Rocklyte Systems
Copyright:  Rocklyte Systems (c) 2000-2001. All rights reserved.
Short:  The execute class runs native binary programs.



Description

The Run class allows you to run the binary programs that are native to the system that Athene is running on. For example, if you are running Athene on a Linux system, the Run class will allow you to run X11 programs and popular applications such as Netscape.

Typical usage in a DML script is as follows:

   <execute src="netscape"/>

If you need to send the program arguments, use the Args field as in this example:

   <execute src="myprogram" args="arg1 arg2 arg3"/>

Like all commands you may make the execute object static if you want it to respond to system events.

Actions

The Run class supports the following actions:

Activate  Activates an Action object.
ClosingTag  If the object is non-static, this action will start the execution process and then the object will self-destruct.

Structure

The Run object consists of the following public fields:

Args  Set this field to send the executable program a range of arguments.
Location  Defines the location/name of the executable program.
Static  Set to TRUE to make the object static.
Field:Args
Short:Set this field to send the executable program a range of arguments.
Type:STRING
Status:Read/Write

If the executable program accepts arguments, then you may send them to the program by setting this field.

 

Field:Location
Synonyms:Src
Short:Defines the location/name of the executable program.
Type:STRING
Status:Read/Write

It is compulsory that this field is set to the location of the executable program that you wish to run. Directory assigns are fully supported, so you may use this file-system feature in specifying the location.

If you are running Athene on a Unix system then you should know that the PATH variable is supported, so you do not need to fully-qualify the location if it is in the path.

 

Field:Static
Short:Set to TRUE to make the object static.
Type:BOOLEAN
Status:Read/Init

By default, a Run object will activate itself and then self-destruct when a closing tag is received. If you would rather that the object stays in the system, set this field to TRUE. If you do this, the only way to get the Run object to perform is to call the Activate() action.