Obtains the value of Editor parameters when REXX is active.
Scope: File
Syntax
Parameter
Name |
The name of an Editor parameter that can be queried. |
Variable |
The name of a REXX variable. The value of the parameter specified by Name is stored in this variable. If not specified, the parameter name is used as the variable. |
Description
In an Editor macro program, you use the extract command to extract the value of an Editor parameter into a REXX variable. This variable can then be operated on or used by program logic structures in macro program.
| Note: | The extract command can only be issued as part of an Editor macro, and will not extract the value of a parameter if issued from the Editor command line. You can issue the query command from the command line to see the value of a parameter. |
Example
To query the doclist parameter and store its value to a REXX variable of the same name, type:
extract doclist
API Return Codes
-1 |
Invalid item found. |
-2 |
REXX not available to set variables. |
