TotalResults Property

Gets the total number of results. This property is populated after calling to Search .

Syntax

 spsearch.getTotalResults([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 getTotalResults([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 setTotalResults([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

Note: This value is not guaranteed to be accurate by SharePoint. The count may be an estimate.

IsTotalResultsExact may be queried after calling Search to determine if TotalResults represents the exact number of results.

This property is read-only.

Data Type

Integer