GetTokenAtOffset Method

Returns the token that contains a specific character.

Syntax

Visual Basic

'Declaration
 
Public Function GetTokenAtOffset( _
   ByVal charOffset As Integer, _
   Optional ByVal splitMultilineTokensByLine As Boolean _
) As Token

C#

public Token GetTokenAtOffset( 
   int charOffset,
   bool splitMultilineTokensByLine
)

Parameters

charOffset

The zero-based offset of the character from the beginning of the line.

splitMultilineTokensByLine

Indicates whether multiline tokens should be split so the the token returned does not span multiple line.

Return Value

The token in question.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	If charOffset is less than 0 or greater than or equal to Length.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2