synonym Parameter

Sets up a synonym.

Scope: File

Syntax

query synonym.Name 
set synonym.Name [Length] Value 

Options

Name 
The synonym you are creating. Must be composed either of just alphanumerics or just special characters.
Length 
Can be up to 25 characters long.
Value 
The command to be issued when Name is typed.

Description

The synonym parameter sets up a synonym for a command. When used at the start of an interactive command, the synonym is replaced by the Value of the synonym before the command is processed by lxi. The mult command can be used to set a single synonym for a string of commands.

If Length is used, the name can be abbreviated to the given length and still be recognized. A synonym name can be no more than 25 characters. There is no restriction on its value.

When a command is processed for synonyms by lxi, the first character determines the kind of synonym. There are two types:

Users should note that an Editor command issued from a REXX macro will not have synonym resolution applied unless the command is prefixed with lxc or lxi.

Examples

  1. To issue the command block mark if any of blockmark, blockmar, blockma, or blockm are used, type:
    set synonym.blockmark 6  block mark 
  2. To issue the command find up any if either - or -/ is used, type:
    set synonym.-/ 1 find up any 

API Return Codes

-2 The Length parameter must be a positive number greater than 1 and less than 25. Issue the set synonym command again with a valid Length.

mult Command
synonymlist Parameter
lxc Command
lxi Command