GetLine Method

8.7C, PLBCMP GUI Only

The GetLine method retrieves a single line of text from a multiline EDITTEXT or a RICHEDITTEXT object. The method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An EDITTEXT or RICHEDITTEXT object that is accessed.

return

Optional. A Character String Variable that receives the selected line.

line

Required. A Numeric Variable or decimal number that indicates the line that is retrieved.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. If {return} is too small to contain value, the OVER condition flag is set.

2. The ZERO and EOS Condition Flags are always cleared.

3. Line numbers are one-based. A value of one specifies the topmost line.

4. The GETLINE method of a RICHEDITTEXT object returns a line with a trailing CR (0x0D) character. The data for the line is retrieved directly from the Windows operating system.

5. This method is not available when using the PL/B Web Server.

See Also: Method Syntax, EDITTEXT Methods, RICHEDITTEXT Methods