ビュー内の列の値に基づいて、その文書を検索します。 ユーザーはキーの配列を作成します。各キーはビュー内のソートした列の値に対応します。このメソッドは、列の値が配列のキーに一致する最初の文書を返します。
Set notesDocument = notesView .GetDocumentByKey( keyArray [, exactMatch% ] )
keyArray
String 型 (可変長のみ)、Integer 型、Long 型、double 型の値、String 型の配列、number か DateTime か DateRange 型のオブジェクトです。配列の各要素は、ビュー内のソートされた列と比較されます。配列の 1 番目の要素はビューのソートされた最初の列と比較され、2 番目の要素はビューのソートされた 2 番目の列と比較されます。
exactMatch%
Boolean 型。オプション。完全一致で検索する場合は True を指定します。キーに完全に一致する最初の文書が返されます。False (デフォルト) を指定するかこのパラメータを省略すると、部分的に一致するものも検索します。部分一致検索では、頭文字がキーと一致する最初の文書が返されます。
notesDocument
NotesDocument。ビュー内の文書の中で、列の値が keyArray の各値と一致した最初の文書を返します。一致する文書がないとき、Nothing を返します。
GetDocumentByKey メソッドを使用するには、少なくとも各キーに対して 1 つの列をソートしておく必要があります。
同じ列内で (「¥¥」特殊文字を使用して) カテゴリとサブカテゴリの両方によってフォーマットされている列がある場合、このメソッドでは文書は検出されません。
このメソッドを配列の keyArray パラメータを指定して COM で使用する場合、このメソッドを Variant 形式の配列として定義する必要があります。
このメソッドは、指定されたキーと列の値が一致する最初の文書だけを返します。一致するすべての文書を検索するには、GetAllDocumentsByKey またはこのメソッドを使用し、続いて GetNextDocument ループを使用します。GetNextDocument ループを使用する場合、次の文書が一致する文書であることを明示的に調べて確認する必要があります。
一致するアイテムの大文字、小文字は区別されません。 例えば、Turban は turban と一致します。 完全一致では、cat は cat と一致しますが、category とは一致しません。 また、20 は 20 と一致しますが、201 とは一致しません。 部分一致では、「T」が「Tim」や「turkey」とも一致し、「attic」とは一致しません。「cat」は「catalog」や「category」とも一致し、「coat」や「bobcat」とは一致しません。
文書のビューエントリ情報を取り出すには、GetEntryByKey メソッドを使用します。ビューエントリの使用方法については、「ビューのエントリを検索する」を参照してください。