GetLine()

Description

Retrieve a line segment based on several parameters.

If there more then one line suitable to the search criteria, only the first found entry will be returned.

This method is to be called from OnRecord context method.

Syntax

Function GetLine( tag, y, [dy], [x], [left_tag], [right_tag] )

Parameters:

string tag - a regular expression pattern which should match the current processed record line.

integer y - how many lines to skip after or before the current line (could be nagative)

integer dy - how many lines to analyze

integer x  - how many characters to skip on each analyzed line (optional)

string left_tag   - a regular expression which describes the left delimiter of the searched string (optional)

string right_tag  - a regular expression which describes the right delimiter of the searched string (optional)

When called without any parameters, this method returns the entire current processed record line.

Return Values:

string - the found line segment

See also

Find()

GetText()

GetValueByTag()

TextConverter's Methods