Previous PageNext Page

8.4.35 InStr Function

Returns the position of the first occurrence of one string within another.
 

Syntax

InStr([start, ]string1, string2[, compare])

Arguments

start
The numeric expression that sets the starting position for each search. If omitted, search begins at the first character position. If start contains Null, an error occurs. The start argument is required if compare is specified. Optional.
string1
The string expression being searched. Required.
string2
The string expression searched for. Required.
compare
A numeric value indicating the kind of comparison to use when evaluating substrings. See Settings section for values. If omitted, a binary comparison is performed. Optional.

Settings

The compare argument can have the following values:
 

Constant Value Description
vbBinaryCompare
 
0
 
Perform a binary comparison.
 
vbTextCompare
 
1
 
Perform a textual comparison.
 

Return Values

The InStr function returns the following values:
 

If InStr returns
string1 is zero-length
 
0
 
string1 is Null
 
Null
 
string2 is zero-length
 
start
 
string2 is Null
 
Null
 
string2 is not found
 
0
 
string2 is found within string1
 
Position at which match is found
 
start > Len(string2)
 
0
 

Note

The InStrB function is used with byte data contained in a string. Instead of returning the character position of the first occurrence of one string within another, InStrB returns the byte position.


Copyright © 2000 Chili!Soft

Previous PageTop Of PageNext Page