Returns the entry at a specified position in the top level of a view navigator.

Defined in

ViewNavigator

Syntax

public ViewEntry getNth(int n)
   throws NotesException

Parameters

int n

Position of the entry, where 1 is the first entry.

ViewEntry

The nth top-level entry. Returns null if there is no nth top-level entry.

This method moves the current pointer to the retrieved entry unless the return value is null.

If you do not have reader access to the specified document, this method returns the next document to which you have reader access. If you increment n, the increment is relative to the actual value of n, not the document that was accessed. So you will access the same document repeatedly until that document actually is the nth document.

Using getNth to iterate through a loop is strongly discouraged for performance reasons. See getNext, getNextCategory, getNextDocument, getNextSibling, getPrev, getPrevCategory, getPrevDocument, and getPrevSibling for the preferred loop structures.

Language cross-reference

GetNth method in LotusScript NotesViewNavigator class

Example
See Also

View navigators

Glossary