Queries breakpoints or bookmarks, or error indications.

Synopsis

line = EditFindFlag(option)

Args

option is which items to query. Any of the following each separated by a '|':

'UNNAME' Unnamed bookmark.
'NAM1' Named bookmark 1.
'NAM2' Named bookmark 2.
'NAM3' Named bookmark 3.
'NAM4' Named bookmark 4.
'NAM5' Named bookmark 5.
'NAM6' Named bookmark 6.
'NAM7' Named bookmark 7.
'NAM8' Named bookmark 8.
'NAM9' Named bookmark 9.
'NAM0' Named bookmark 10.
'BREAK' Breakpoint.
'ERROR' Error indication.

You can also specify any one of the following:

'DOWN' Search for the next line with one of the items set.
'UP' Search for a previous line with one of the items set.
'HOME' Search from the beginning for the next matching line, with no wraparound.

If omitted, 'UNNAME|DOWN' is assumed.

Returns

The line number of the line that has at least one of the specified items set, or 0 if none. Otherwise, if there is an error, a -1 is returned.

Notes

If UP, DOWN, or HOME are not specified, then the current line is queried to see if it contains any of the specified items. If so, then the line's number is returned. If not, a 0 is returned.

If DOWN is specified, then the next line (after the current line) with any of the specified items is located, and its line number is returned. Note that the search wraps around, so the matching line could be before the current line. But the search proceeds in a downward direction before any wraparound occurs.

If UP is specified, then the previous line (before the current line) with any of the specified items is located, and its line number is returned. Wraparound may occur.

If HOME is specified, then the search starts at the first line and proceeds in a downward direction. There is no wraparound when the end of the editor is reached.

If a matching line is found, the text cursor is set to the beginning of that line.