Siebel VB Language Reference > VB Language Reference >
This standard VB function returns the position of the first occurrence of one string within another string.
InStr([start,] string1, string2)
InStr(start, string1, string2[, compare])
An integer representing the position in string1 to begin the search, with the first character in the string as 1
The string to search
The string to find
0 if a case-sensitive search is desired
1 if a case-insensitive search is desired
The position of the first character of string2 in string1.
If not specified, the search starts at the beginning of the string (equivalent to a start of 1). These arguments can be of any type. They are converted to strings.
InStr returns a zero under the following conditions:
- start is greater than the length of string2.
- string1 is a null string.
- string2 is not found.
If either string1 or string2 is a null variant, Instr returns a null variant.
If string2 is a null string (""), Instr returns the value of start.
If compare is 0, a case-sensitive comparison based on the ANSI character set sequence is performed. If compare is 1, a case-insensitive comparison is done based upon the relative order of characters as determined by the country code setting for your computer. If compare is omitted, the module level default, as specified with Option Compare, is used.
This example generates a random string of characters, then uses InStr to find the position of a single character within that string.
Dim x as Integer
Dim str1 as String
Dim str2 as String
Dim letter as String
Dim upper, lower
Dim position as Integer
Dim msgtext, newline
upper = Asc("z")
lower = Asc("a")
newline = Chr(10)
For x = 1 to 26
randomvalue = Int(((upper - (lower + 1)) * Rnd) + lower)
letter = Chr(randomvalue)
str1 = str1 & letter
'Need to waste time here for fast processors
For y = 1 to 1000
str2 = "i"
position = InStr(str1,str2)
If position then
msgtext = "The position of " & str2 & " is: " _
& position & newline & "in string: " & str1
msgtext = "The letter: " & str2 & " was not found in: " _
msgtext = msgtext & str1
Option Compare Statement