GetAllDocumentsByKey (NotesView - LotusScript®)

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

定義位置

NotesView

構文

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

パラメータ

keyArray

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

exactMatch%

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 メソッド