Click to Rate and Give Feedback
MSDN
MSDN Library
Web Development
Scripting
VBScript
 InStr Function

  Switch on low bandwidth view
This page is specific to
.NET Framework 3.0

Other versions are also available for the following:
Visual Basic Scripting Edition
InStr Function

Updated: April 2009

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

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

Optional. Numeric expression that sets the starting position for each search. The first character position is position 1.

If this argument is omitted, search begins at the first character position. If start contains Null, an error occurs. The start argument is required if compare is specified.

string1

Required. String expression being searched.

string2

Required. String expression searched for.

compare

Optional. Numeric value indicating the kind of comparison to use when evaluating substrings. See Settings section for values. If omitted, a binary comparison is performed.

The compare argument can have the following values:

Constant

Value

Description

vbBinaryCompare

0

Perform a binary comparison.

vbTextCompare

1

Perform a textual comparison.

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(string1)

0

The following examples use InStr to search a string:

Dim MyPos

' This is a binary comparison because the last argument is omitted.
' Returns 3.
MyPos = InStr ("abcdefgh", "c")

' In this binary comparison, the uppercase "C" is not found
' in the lowercase string.
' Returns 0 (not found).
MyPos = InStr ("abcdefgh", "C")

' In this text comparison starting at the first position,
' the uppercase "C" is found in the lowercase string.
' Returns 3.
MyPos = InStr (1, "abcdefgh", "C", vbTextCompare)
NoteNote:

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.

Date

History

Reason

April 2009

Modified example and start argument definition.

Customer feedback.

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Better specification      newinter   |   Edit   |   Show History
The explanation is quite good but what are the limist for the values tu use in function call? Is the minimum value for the parameter start 1 or 0 ? Yes It's BASIC but not everyone have used it!
Flag as ContentBug
TEXT COMPARISON      WVONB   |   Edit   |   Show History

Three options are provided - vbBinaryCompare (1), vbDatabaseCompare (2) & vbTextCompare (3)

Flag as ContentBug
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker