SearchExcludeVoid Property

Indicates whether or not to exclude void transactions from the search results.

Syntax

 globaltransactionsearch.getSearchExcludeVoid([callback])
 globaltransactionsearch.setSearchExcludeVoid( searchExcludeVoid, [callback])

Default Value

FALSE

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 getSearchExcludeVoid([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 setSearchExcludeVoid([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

Indicates whether or not to exclude void transactions from the search results.

Data Type

Boolean