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

定義位置

NotesView

構文

Set notesDocumentCollection = notesView.GetAllDocumentsByKey( keyArray [, exactMatch% ] )

パラメータ

keyArray

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

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

notesDocumentCollection

NotesDocumentCollectionビュー内で列の値が keyArray の各値と一致したすべての文書を返します。一致するエントリがない場合、コレクションは空で、カウント数はゼロになります。

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

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

このメソッドは、列の値が指定したキーと一致したすべての文書を返します。一致する最初の文書だけを検索したいときには、GetDocumentByKey を使用します。

このメソッドで返される文書は特定の順序で表示されることはありません。また、ColumnValues にアクセスすることもできません。この場合は、GetAllEntriesByKey メソッドを使用します。

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

複数のキーを使用した部分検索では、文書を検索し損ねる可能性があります。最初のキーを部分一致にした場合、2 番目の列でそのキーが完全一致と同じようにソートされていないと、順序の異なる文書は検索から外れます。

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

クロスリファレンス

Java View クラスの getAllDocumentsByKey メソッド

例
関連項目

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

用語集