VBMatch_GetFirstIndex

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > VBRegExp >

VBMatch_GetFirstIndex

 

Description

 

Returns the position in a search string where a match occurs.

 

Syntax

 

n = VBMatch_GetFirstIndex(pMatch)

 

Returns

 

Number

 

Parameters

 

Name

Type

Optional

Meaning

pMatch

Numeric

No

A match object reference pointer

 

Remarks

 

The FirstIndex property uses a one-based offset from the beginning of the search string. In other words, the first character in the string is identified as character one (1)

 

Restrictions

 

See also

 

Examples