EntryIndex Property

The index of the current entry in an OData feed.

Syntax

 odata.getEntryIndex([callback])
 odata.setEntryIndex( entryIndex, [callback])

Default Value

-1

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getEntryIndex([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setEntryIndex([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property is used to specify an entry within a retrieved OData feed. Once set, EntryAuthor, EntryETag, EntryTitle, EntrySummary, EntryUpdated, EntryLinks, EntryProperties and ResourcePath will be populated with their respective values found within the entry.

This property takes index values from 0 to EntryCount-1.

Setting EntryIndex to -1 will clear the entries contained by the component and will also reset EntryProperties and EntryCount.

This property is not available at design time.

Data Type

Integer