substitute Command

Causes symbol substitution.

Scope: File

Syntax

Parameter

all 
Scans the whole file for symbol substitution. The scanning is done from right to left.

Description

The substitute command causes symbol substitution on demand, instead of automatically as it would if the autosymbols parameter was set to on. If the all parameter is not included, only the current line is scanned.

Example

To set substitution on demand for all lines, type:

substitute all 

API Return Codes

1 
There are no symbols to convert to special characters in the file. If you think there are symbols within the file, check that the symbols have been spelled correctly and that they are defined with the set symbol command.
2 
There are no symbols to convert to special characters in the line. If you think there are symbols within the line, check that the symbols have been spelled correctly and that they are defined with the set symbol command.
-2 
A parameter issued with the command was not valid. Check the command 's syntax requirements and then issue the command again using a valid parameter.


autosymbols parameter
symbol Parameter
symbollist Parameter