文字列内で特定の文字列を検索し、最初に検出された文字の位置を返します。
InStr ( [ begin , ] string1 , string2 )
または
InStr ( [ begin , ] string1 , string2 [, compMethod ] )
begin
オプション。正の整数値を表す数式です。begin では、InStr が string2 を検索し始める string1 内の文字の位置を指定します。begin を省略した場合、既定は 1 です。compMethod を指定した場合は、begin も指定しなければなりません。
string1
string2 の検索対象となる文字列です。
string2
string1 内で検索される文字列です。
compMethod
比較方法を示す数値です。
| 数値 |
比較方法 |
|---|---|
| 0 |
大文字と小文字および全角と半角を区別します。 |
| 1 |
大文字と小文字を区別しません。全角と半角を区別します。 |
| 4 |
大文字と小文字を区別します。全角と半角を区別しません。 |
| 5 |
大文字と小文字を区別しません。全角と半角を区別しません。 |
compMethod を指定した場合は、begin も指定しなければなりません。
compMethod を省略すると、デフォルトの比較モードは、このモジュールの Option Compare ステートメントで設定されたモードになります。モジュールに対して比較方法が宣言されていない場合は、既定で大文字と小文字および全角と半角が区別されます。
InStr は、string1 内で最初に string2 が見つかった位置を返します。次の表は、いくつかの条件下での関数の戻り値を示しています。
| 条件 |
戻り値 |
|---|---|
| string1 が空の文字列 ("") |
0 |
| string2 が string1 の begin 以降に見つからない |
0 |
| begin が string1 より長い |
0 |
| string2 が空の文字列 ("") |
begin の値 (begin を省略した場合は 1) |
| string1 が NULL |
NULL |
| string2 が NULL |
NULL |
| begin または compMethod が NULL |
エラー |
バイト単位で処理する場合は、InStrB 関数を使用します。