SelectionParameterIndex Property

The index of the current selection parameter.

Syntax

 sapquery.getSelectionParameterIndex([callback])
 sapquery.setSelectionParameterIndex( selectionParameterIndex, [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 getSelectionParameterIndex([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 setSelectionParameterIndex([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 the selection parameter. Once set, the following properties will be populated:

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

This property is not available at design time.

Data Type

Integer