Tokenizer_MoveToEol

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > Tokenizer >

Tokenizer_MoveToEol

 

Description

 

Advance the current position variable till the next End Of Line.

 

Syntax

 

n = Tokenizer_MoveToEol(BufferVariable, CurrentPositionVariable [, OnlyRealCRLF])

 

Returns

 

Number

 

Parameters

 

Name

Type

Optional

Meaning

BufferVariable

String variable

No

The name of an existent keyword name. Keyword can be taken from whatever module but module must already been loaded.

CurrentPositionVariable

Numeric variable

No

A variable containing the current Tokenizer position. It will be moved to the next end of line char (or chars)

OnlyRealCRLF

Numeric

Yes

If %TRUE, only CR (carriage return) or LF (line feed) will be considered in searching for the next EOL.

If omitted or %FALSE, also chars defined by script as new line chars will be considered.

 

Remarks

 

Important: BufferVariable and CurrentPositionVariable parameters must be variable and not expressions. This is because they must be passed by reference in order to get back information.

 

Restrictions

 

See also

 

Examples