GetEntryByKey (NotesView - LotusScript®)

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

注: このメソッドは R5 で新しく追加されました。

定義位置

NotesView

構文

Set notesViewEntry = notesView .GetEntryByKey( keyArray [, exactMatch% ] )

パラメータ

keyArray

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

exactMatch%

Boolean 型。オプション。完全一致で検索する場合は True を指定します。キーに完全に一致する最初のエントリが返されます。False (デフォルト) を指定するかこのパラメータを省略すると、部分的に一致するものも検索します。部分一致検索では、頭文字がキーと一致する最初のエントリが返されます。

戻り値

notesViewEntry

NotesViewEntry オブジェクト。ビュー内のエントリの中で、列の値が keyArray の各値と一致した最初のエントリを返します。一致するエントリがないときは Nothing を返します。

使用法

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

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

同じ列内で (「¥¥」特殊文字を使用して) カテゴリとサブカテゴリの両方によってフォーマットされている列がある場合、このメソッドではエントリは検出されません。

このメソッドは、指定されたキーと列の値が一致する、ビューの最初のエントリだけを返します。一致するすべてのエントリを検索するには、GetAllEntriesByKey メソッドを使用します。

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

このメソッドは、GetDocumentByKey に類似しています。文書の使用方法については、「ビュー内の文書を検索する」を参照してください。

クロスリファレンス

Java™ View クラスの getEntryByKey メソッド