getNthItemValue (NotesDirectoryNavigator - JavaScript™)
Positions navigator to nth match of the current name in the navigator and returns the value of the current item.
Defined in
NotesDirectoryNavigatorSyntax
getNthItemValue(n:int) : any | Parameter | Description |
|---|---|
int n |
The number of the match at which to position the navigator, starting with 1. |
| Return value | Description |
|---|---|
Vector |
The value of the current item of the nth match. |
Usage
Positions navigator to the nth match of the current name, and updates the CurrentItem property with the item name.The only way to advance the current item is by use of the getNextItemValue method.
This method always returns an array. If it is a single valued item, only the first value of the array will be populated.