テキスト文字列から指定した語を返します。

メモ この関数は Lotus Domino Release 6 で新しく追加されました。

構文

StrToken (expression, delimiter, wordNumber [, compMethod])

要素

expression

検索する文字列を含む文字列です。

expression の語を区切る文字を含む文字列です。

expression のどの語を返すかを指定する Long 型です。

省略可能。区切り記号の検索に使用する比較のタイプを指定する数値です。

数値	比較のモード
0	大文字と小文字および全角と半角を区別します。
1	大文字と小文字を区別しません。全角と半角を区別します。
4	大文字と小文字を区別します。全角と半角を区別しません。
5	大文字と小文字を区別しません。全角と半角を区別しません。


compMethod を省略すると、既定の比較モードはこのモジュールの Option Compare ステートメントで設定されたモードになります。モジュールに何もステートメントがなければ、大文字と小文字および全角と半角が区別される比較方法が既定となります。

String 型を返します。返される String 型は expression からの指定された語です。

使用法

StrToken はテキスト文字列から指定された語を返します。「単語」とは、文字列の一部で、分離記号として指定された (1 つまたは複数の) 文字で区切られたものです。たとえば、区切り文字としてスペース (" ") を指定すると、単語は前後にスペース (あるいは文字列の最初または最後を示す引用符 (')) の入った一連の文字になります。たとえば「hello there」は、4 つの単語 (「」、「hello」、「there」、「」) から構成されます。

メモ 最初の「」は、左側が文字列の始まり、右側が区切り文字で区切られているため、単語と解釈されます。

expression は複数の単語に分解され、wordNumber で指定された位置にある単語が返されます。

区切り文字が複数文字である場合、これらの文字の一部だけでは区切り文字として機能しません。たとえば、区切り文字が「 」(2 つのスペース) である場合、1 つのスペースは区切り文字として認識されません。

wordNumber の絶対値が語数より大きい場合は、指定した語は空の文字列として認識されます。

wordNumber がゼロの場合、指定した語は文字列の最初の語として認識されます (wordNumber=0 は wordNumber=1 と同じとみなされます)。

wordNumber がゼロ未満の場合は、指定した語が文字列の最後の語から逆算して数えることで検出されます。

エラー処理

StrToken は、expression または delimiter がスカラー型でない場合、または wordNumber が long 型でない場合 (コンパイラが long 型に変換できない場合)、ランタイムの型の不一致をスローします。

optionCompare が不正な値の場合は、引数範囲外のランタイムエラーが発生します。

クロスリファレンス

式言語の @Word 関数

例
関連項目

LotusScript ランゲージリファレンス: Q - T

用語集