Free: Difference between revisions
(Created and added new Syntax diagram) |
(→Syntax) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
The '''Free (FR)''' | The '''Free (FR)''' command deletes one or more files from the system. | ||
==Comments and Examples== | |||
The following example removes the file PROG1.BR from the default directory of drive B and prevents the screen from displaying the log of actions: | The following example removes the file PROG1.BR from the default directory of drive B and prevents the screen from displaying the log of actions: | ||
Free B:Prog1.br -N | Free B:Prog1.br -N | ||
==Syntax== | |||
FREE <file name> {[>[>] <output file>]|[PRINT]} [-<[[free option|option]]>][-...] | |||
[[Image:Free.png]] | [[Image:Free.png]] | ||
== | ==Defaults== | ||
Display on the screen any actions performed. | Display on the screen any actions performed. | ||
==Parameters== | |||
FREE requires the | FREE requires the '''file name''' parameter, which accepts wildcard characters | ||
The optional | The optional '''>redirected output file''' parameter sends messages that normally appear on the screen during the FREE procedure to the specified file. '''PRINT''' sends screen messages to the printer. | ||
Three optional parameters, when separated from the rest of the command with a dash, can follow the FREE command: | |||
'''A''' causes only files with the archive bit on to be dropped on DOS versions. Linux versions ignore this option. | |||
As | |||
'''N''' prevents the screen from displaying a log of performed actions. | |||
'''P''' causes scrolling to pause after the log of freed files fills one screen. Press <ENTER> for the next screen. | |||
'''V''' requires the operator to Verify actions before Business Rules performs them. | |||
==Technical Considerations== | |||
As BR closes a [[procedure]] before executing the last line, the procedure can free itself when FREE is the last line. A procedure file which is named with a [[.$$$]] extension will automatically free itself after executing. | |||
Latest revision as of 16:15, 6 May 2014
The Free (FR) command deletes one or more files from the system.
Comments and Examples
The following example removes the file PROG1.BR from the default directory of drive B and prevents the screen from displaying the log of actions:
Free B:Prog1.br -N
Syntax
FREE <file name> {[>[>] <output file>]|[PRINT]} [-<option>][-...]
Defaults
Display on the screen any actions performed.
Parameters
FREE requires the file name parameter, which accepts wildcard characters
The optional >redirected output file parameter sends messages that normally appear on the screen during the FREE procedure to the specified file. PRINT sends screen messages to the printer.
Three optional parameters, when separated from the rest of the command with a dash, can follow the FREE command:
A causes only files with the archive bit on to be dropped on DOS versions. Linux versions ignore this option.
N prevents the screen from displaying a log of performed actions.
P causes scrolling to pause after the log of freed files fills one screen. Press <ENTER> for the next screen.
V requires the operator to Verify actions before Business Rules performs them.
Technical Considerations
As BR closes a procedure before executing the last line, the procedure can free itself when FREE is the last line. A procedure file which is named with a .$$$ extension will automatically free itself after executing.