num-var = SPF_OVR_REP(line-ptr, col-num, data-str)


Operands:

line-ptr

the line pointer for the data line to be overlaid. Line-ptr is a normal Internal line pointer.



col-num

the column number at which the data-str contents are to be overlaid.



data-str

the new contents of data line to be overlaid


Returns:


Both num-var and RC will be 0 and Msg$ will be "" (Null) for successful completion

Both num-var and RC will be 8 and Msg$ set to an error message on failure (e.g. invalid line pointer)


Special Notes:


Will overlay replace text in line-ptr with data-str starting at the indicated column col-num. Other text in the line is unaffected. If needed, the line's text will be extended with blanks to col-num - 1 before data-str is copied in.


Overlay replace consists or replacing characters from data-str into the same relative location in the lines text only when the characters in data-str are non-blank. i.e. similar to the previous SPF_OVR except here non-blanks in data-str take precedent over the original text. In SPF_OVR, non-blanks in the original text take precedent.


Compare the functionality of SPF_OVR_REP to the OR/ORR edit line commands.


Created with the Personal Edition of HelpNDoc: Effortlessly Create High-Quality Documentation with a Help Authoring Tool