ItemIndex Property

The index of the current Item in the response.

Syntax

 paapi.getItemIndex([callback])
 paapi.setItemIndex( itemIndex, [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 getItemIndex([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 setItemIndex([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

After parsing the XML received from the server, the class attempts to find a list of items in the response. When successful, the ItemCount will be a positive number greater than zero. When this occurs, and the user sets ItemIndex to a valid index, the XPath will be set to the path of the desired item.

This property is not available at design time.

Data Type

Integer