PSObjectIndex Property

The index of the current object selected in the list of outputs.

Syntax

 psclient.getPSObjectIndex([callback])
 psclient.setPSObjectIndex( PSObjectIndex, [callback])

Default Value

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 getPSObjectIndex([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 setPSObjectIndex([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

Specifies the index of the PowerShell object from the list of the output items returned by the server.

Setting this property causes the PSObjectBaseType, PSObjectValue, and PSObject properties to be updated to reflect the corresponding values of the PowerShell object at the specified index.

This property is not available at design time.

Data Type

Long