SearchMarker Property

A marker when searches are paged.

Syntax

 box.getSearchMarker([callback])
 box.setSearchMarker( searchMarker, [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 getSearchMarker([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 setSearchMarker([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 populated when Search is called and the results span multiple pages. Search may be called multiple times to get the next page of results. If this value is empty after calling Search there are no additional pages of results.

This property is not available at design time.

Data Type

String