LineFromChar Method

8.7C, PLBCMP GUI Only

The LineFromChar method retrieves the line number that contains the specified character index in a multiline EDITTEXT or RICHEDITTEXT object. The method uses the following format:

	[label]	{object}.LineFromChar	[GIVING {return}]
			USING [CharIndex=]{charndx*}

Where:

label

Optional. A Program Execution Label.

object

Required. An EDITTEXT or RICHEDITTEXT object that is accessed.

return

Optional. A Numeric Variable that indicates the one based line number.

charndx

Required. A decimal number or Numeric Variable that specifies the one-based character index.

Flags Affected: EOS, OVER, ZERO

Note the following:

If the value returned is zero, the ZERO condition flag is set.
The OVER and EOS Condition Flags are always cleared.
The returned value is the one-based index of the character from the beginning of the EDITTEXT object.
A character index of zero specifies that the line number of the current line (the line containing the caret) or, if there is a selection, the line number of the line containing the beginning of the selection should be returned.
When using the PL/B Web Server, this method is not supported.