InStrB function (LotusScript® Language)

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

Syntax

InStrB ( [ begin , ] string1 , string2 )

Elements

begin

Optional. A numeric expression with a positive integer value, begin specifies the character position in string1 where InstrB should begin searching for string2. If you omit begin, it defaults to 1.

string1

The string to be searched.

string2

The string for which InStrB searches.

Return value

InStrB returns the byte position of the first occurrence of string2 in string1. The following table shows how the function responds to various conditions.

Condition

Return value

string1 is " " (the empty string)

0

string2 is not found after begin in string1

0

begin is larger than the length of string1

0

string2 is "" (the empty string)

The value of begin. (If you omit begin, InStrB returns the value 1.)

string1 is NULL

NULL

string2 is NULL

NULL

begin is NULL

Error

Usage

If you want to work with characters, use the InStr function.

Note: The byte position returned by InStrB is independent of the platform-specific byte order.

Example