pending Parameter

Adds a line to a pending list being processed by a parser.

Scope: Line

Syntax

query pending 
set pending { off | change | delete | both } 

Options

off 
Drops current line from the pending list. This is the default value.
change 
Line is added to the pending list following a change to the content of the line.
delete 
Line is added to the pending list following the deletion of another line.
both 
Line is added to the pending list following a change in the content of the line and the deletion of another line.

Description

The pending parameter adds or drops the current line from the pending list of lines waiting to be processed by the parser. Lines are added to the pending list if a parser has been specified by the set parser command and the text content of the lines is changed. A line is also automatically added to the list if the parser has been specified and the line becomes the current line after another line is deleted.

Lines can be changed by commands such as insert or set content, or by overtyping. If a line is changed by overtyping, it is added to the list when the cursor is moved off the line.

The query pending command indicates whether the current line is on the pending list because of changes.

Examples

  1. To see if the current line is on the pending list, type:
    query pending 
  2. To drop the current line from the pending list, type:
    set pending off 
  3. To add a line to the list following a change to the content of the line, type:
    set pending change 

API Return Codes

-2 
The option specified with the parameter was not valid. Check the syntax requirements for the parameter and try the set command again.
-5 
You cannot make changes to the file because the readonly parameter is set to on.

autoparse Parameter
parser Parameter
trigger Command