num-var = Get_Next_LPtr(line-ptr, adjust-amount, line-type)


Operands:

line-ptr

The starting line-pointer to be adjusted and returned.



col-num

The number of lines by which the line-ptr is to be adjusted. Positive values indicate adjustment downward in the file (towards the last line) and negative values indicate adjustment upward in the file (towards the top line).



line-type

This is a string operand which may be one of:

DATA        Adjustment is made where adjust-amount is measured by counting only DATA line types


SPECIAL        Adjustment is made where adjust-amount is measured by counting only non-DATA (i.e. SPECIAL) line types


:tagname        Adjustment is made where adjust-amount is measured by counting only lines which have a matching line tag. 



Returns:


The adjusted line-ptr as requested. If it is impossible to satisfy the request (e.g. movement has reached either the top or bottom of the file, depending on direction) then 0 (zero) will be returned and RC and Msg$ set with appropriate error indications. 


Special Notes:


The Get_Next_LPtr function will typically be used in line scanning loops to move from a currently processed line to the next/previous line of a particular type.


Created with the Personal Edition of HelpNDoc: Benefits of a Help Authoring Tool