RangeStart Property
The starting index of the results.
Syntax
spsearch.getRangeStart([callback]) spsearch.setRangeStart( rangeStart, [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 getRangeStart([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 setRangeStart([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 specifies which result to start with when returning the results of the search. This may be set to begin returning results at a certain offset. This allows the results to effectively be paged.
Data Type
Integer