ビューの列の値を使用して文書を検索します。ユーザーはキーの配列を作成します。各キーはビュー内のソートした列の値に対応します。このメソッドは、列の値が配列のキーに一致する最初の文書を返します。

定義位置

NotesView

構文

Set notesDocument = notesView.GetDocumentByKey( keyArray [, exactMatch% ] )

パラメータ

keyArray

String 型 (可変長のみ)、Integer 型、Long 型、または double 型の値、あるいは String 型の配列、number か DateTime か DateRange 型のオブジェクトです。配列の各要素は、ビュー内のソートされた列と比較されます。配列の 1 番目の要素はビューのソートされた最初の列と比較され、2 番目の要素はビューのソートされた 2 番目の列と比較されます。

Boolean 型。省略可能。完全に一致するものを検索したいときには True を指定します。キーに完全に一致する最初の文書が返されます。False (デフォルト) を指定するかこのパラメータを省略すると、部分的に一致するものも検索します。部分一致検索では、頭文字がキーと一致する最初の文書が返されます。

notesDocument

NotesDocument。ビュー内の文書の中で、列の値が keyArray の各値に一致する最初の文書を返します。一致する文書がないとき、Nothing を返します。

GetAllDocumentsByKey メソッドを使用するには、少なくとも各キーに対して 1 つの列をソートしておく必要があります。

同じ列内で、カテゴリとサブカテゴリの両方を使用してフォーマットされた列がある場合 (特殊文字の "\\" を使用)、1 つの列内でカテゴリとサブカテゴリの両方を使用している最後の一致文書を開始位置として、keyArray 値に一致する列を持つ最初の文書が返されます。

このメソッドを配列の keyArray パラメータを指定して COM で使用する場合、このメソッドを Variant 形式の配列として定義する必要があります。

このメソッドは、指定されたキーと列の値が一致する最初の文書だけを返します。一致するすべての文書を検索するには、GetAllDocumentsByKey またはこのメソッドを使用し、続いて GetNextDocument ループを使用します。GetNextDocument ループを使用する場合、次の文書が一致する文書であることを明示的に調べて確認する必要があります。

大文字と小文字は区別されません。たとえば、「Turban」は「turban」と一致します。完全一致の場合、「cat」は「cat」とのみ一致し、「category」とは一致しません。また、「20」は「20」とのみ一致し、「201」とは一致しません。部分一致では、「T」が「Tim」や「turkey」とも一致し、「attic」とは一致しません。「cat」は「catalog」や「category」とも一致し、「coat」や「bobcat」とは一致しません。

文書のビューエントリ情報を取り出すには、GetEntryByKey メソッドを使用します。ビューエントリの使用方法については、「ビューのエントリを検索する」を参照してください。

クロスリファレンス

Java View クラスの getDocumentByKey メソッド

式言語の FileOpenDatabase @コマンド

例
関連項目

LotusScript のクラスでビューやフォルダ内の文書を検索する

用語集