ReadText (NotesStream - LotusScript®)
Reads text lines from a stream.
Defined in
Syntax
text$ = notesStream .ReadText( [ oneLine& ] , [ eol& ] )
Parameters
oneLine&
Optional. Constant of type Long.
- STMREAD_LINE (0) reads one line.
- Defaults to the entire stream to a maximum of 2GB.
eol&
Optional. Constant of type Long. End-of-line character(s) within the text. The default is EOL_CRLF.
- EOL_ANY (4) treats any of EOL_CR, EOL_CRLF, or EOL_LF as end-of-line.
- EOL_CR (2) treats a carriage return (ASCII 13) as end-of-line.
- EOL_CRLF (0) treats a carriage return and line feed (ASCII 10 + 13) as end-of-line. Default.
- EOL_LF (1) treats a line feed (ASCII 10) as end-of-line.
- EOL_NONE (5) treats nothing as end-of-line.
- EOL_PLATFORM (3) follows the conventions of the current platform.
Return value
text$
String. The text read.
Usage
This method starts at Position and reads text until end of line, including the end-of-line character, or end of stream.