submit Command

Invokes an Editor macro to run on a secondary thread, thereby allowing the user to continue interacting with the Editor.

Scope: File

Syntax

Options

read 
The Editor macro will read the Editor's content without updating the text.
write 
The Editor macro will update the text in the edit window. This is the default option.
none 
No lock is applied.
stop 
The Editor macro will honor a Stop pushbutton in the progress indicator.
synch 
If selected, the submit command will not lock up the main thread while waiting for the macro to complete.
Description 
The description text to be displayed in the progress indicator.
EditorMacro 
Certain Editor macros supplied with the product for language-sensitive editing support.

Description

The submit command places the specified access lock on the Editor before invoking the supplied command on a secondary thread. A progress indicator is displayed with the optional description text. The command string is displayed as the description by default.

Notes:
  1. Multiple concurrent read accesses are allowed; however, only one write access is allowed at any one time.
  2. When an Editor window is locked for write access, read access requests will be queued up. When an edit window is locked for read access, write access requests are rejected.
  3. Only certain IBM-supplied (default) Editor macros, which observe the proper protocol for concurrent execution, can be invoked with the submit command.

Example

To invoke the CL tokenizer to perform a total parse:

submit read stop "Parsing file" evflcl all 

API Return Codes

-1 
There is not enough system resource to invoke the command to run in a secondary thread.
-2 
The ending quote for the description text is missing.

start Command