Class Documentation
Assign |
1.0 |
ID_ASSIGN |
Stable |
Command |
January 2004 |
Rocklyte Systems |
Rocklyte Systems (c) 2000-2004. All rights reserved. |
Description
The Assign command class is provided for the purpose of adding, deleting
and altering assignments in the system. Assignments provide a "virtual
directory" service that is used to manage the roots of the file
system. From a user perspective they can be very helpful when used to
provide directory short-cuts. They are also used by the system to define
standard directory names at the root level of the file system (see the
"system:config/assignments.cfg" file for a list).
Keep in mind that this class is only for use in command lines and as a
scripting command. When programming with a traditional language, the
functions in the FileSystem module should be used.
Structure
The Assign object consists of the following public fields:
Add | Adds a list of paths to an assignment name. |
Delete | Deletes an assignment from the system. |
Output | Result messages will be sent to the object referred to in this field. |
Replace | Replaces the path of an existing assignment with a new path. |
Field: | Add |
Short: | Adds a list of paths to an assignment name. |
Type: | STRING |
Status: | Set |
Setting the Add field with a list of paths will add those paths to the
specified assignment. This will have the effect of preserving any existing
paths that are attributed to the assignment, if it already exists. If the
assignment does not already exist, a new one will be created from scratch.
The string format to use when setting this field is:
"assign;path1/;path2/;path3/;..."
For example:
"templates;scripts:boot/wintel/templates/"
|
|
Field: | Delete |
Short: | Deletes an assignment from the system. |
Type: | STRING |
Status: | Set |
Assignments can be deleted by writing this field with the name of the
assignment that you want to delete. If multiple paths are hooked into the
assignment, they will all be deleted.
|
|
Field: | Output |
Short: | Result messages will be sent to the object referred to in this field. |
Type: | OBJECTID |
Status: | Read/Write |
If this field is set to a valid ObjectID, text messages will be sent to
the object when the Assign process executes. This can be helpful for
notifying the user of the results of a comand's execution.
The object receiving the message must be capable of understanding text
sent via data channels. In most cases it is recommended that a Text
object is used for this purpose.
|
|
Field: | Replace |
Short: | Replaces the path of an existing assignment with a new path. |
Type: | STRING |
Status: | Set |
This field is used to replace assignments with completely new path lists.
It can also can be used to add new assignments if the specified assignment
name does not exist. The string format to use when setting this field
is:
"assign;path1/;path2/;path3/;..."
For example:
"templates;scripts:boot/templates/;scripts:boot/wintel/templates/"
|
|