Finds a view entry of type document based on its column values within a view. You create an array of keys, where each key corresponds to a value in a sorted column in the view. The method returns the first entry whose column values match each key in the array.

Note This method is new with Release 5.

Defined in

NotesView

Syntax

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

Parameters

keyArray

String (variable-length only), integer, long or double value, or array of string, number, DateTime, or DateRange objects. Each element in the array is compared to a sorted column in the view. The first element in the array is compared to the first sorted column in the view; the second element is compared to the second sorted column; and so on.

Boolean. Optional. Specify True if you want to find an exact match. The first entry that matches the key exactly is returned. If you specify False (the default) or omit this parameter, a partial match succeeds. Partial matches return the first entry that matches the initial characters of the key.

notesViewEntry

A NotesViewEntry object. The first entry in the view whose column values match each of the values in the keyArray. Returns Nothing if there is no matching entry.

For the GetAllDocumentsByKey method to work, you must have at least one sorted column for each key.

If this method is used under COM, with a keyArray parameter of an array, it must be defined as an array of type Variant.

If any columns are formatted with both categories and subcategories in the same column (using the "\\" special character), the method will return the first entry whose column values match the keyArray values, after the last matching entry which uses both a category and a subcategory in one column.

This method returns only the first entry within the view whose column values match the keys you indicate. To locate all the matching entries, use the GetAllEntriesByKey method.

Matches are not case-sensitive. For example, "Turban" matches "turban." In an exact match, "cat" matches "cat" but does not match "category," while "20" matches "20" but does not match "201." In a partial match, "T" matches "Tim" or "turkey," but does not match "attic," while "cat" matches "catalog" or "category," but does not match "coat" or "bobcat."

This method is similar to GetDocumentByKey. See Locating documents within a view for information about working with documents.

Language cross-reference

getEntryByKey method in Java View class

Example
See Also

Locating an entry in a view

Glossary