 |
CCP4i: Graphical User Interface |
| Documentation for Programmers | |
| AddOutputFile |
|
NAME
AddOutputFile - Add extra file(s) to the list of output files for a job.
SYNOPSIS
AddOutputFile filename1 dir_alias1 ... filenamen dir_aliasn
DESCRIPTION
When a tasks creates files whose names are only decided at run time then AddOutputFile can be used to update the project database with the names of the output files. Any number of files can be added to the database, each file contributes two arguments to the procedure: the filename (which does not need to include the full path to the file) and the directory alias for the directory which contains the file. The directory alias must be one of the aliases in the user's directories.def or the word 'PROJECT' in which case the user's current project directory is assumed, or 'MAP_DEFAULT', in which case the user's perferred directory for map files is assumed. The MAP_DEFAULT keyword is liable to be used in conjunction with the -map argument to SetOutputFileRoot.
This procedure will communicate the names of the output files to the main graphical interface and the main graphical interface will update the database file. The names of the output files will also be listed in the summary at the end of the log file.
Directories can also be registered as output ``files'' by specifying an empty string as the filename, or by invoking a separate command called AddOutputDir:
AddOutputDir dir1 ... dirn
dir1 ... dirn are directory aliases or full paths. Directories registered this way will not be displayed in the list of output files for the job but will be included when the user selects the ``Archive/Delete'' function.