EntityIndex Property

Indicates the index of the current entity.

Syntax

 table.getEntityIndex([callback])
 table.setEntityIndex( entityIndex, [callback])

Default Value

0

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 getEntityIndex([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 setEntityIndex([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

The index of the current entity. EntityIndex valid values are from 0 to EntityCount - 1. Setting this property will populate EntityURL, EntityLastModified, EntityETag, EntityPartitionKey and EntityRowKey and also populate EntityProperties with the properties of the specified entity.

This property is not available at design time.

Data Type

Integer