FindClose Method

Closes a search operation and releases any associated resources.

Syntax

cbdrive.findClose(searchHandle, [callback])

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 this 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 method closes the search operation identified by SearchHandle, releasing any previously-allocated resources associated with it.

The value passed for SearchHandle must be a search operation handle returned by FindFirst or FindFirstByQuery.

Note: This method can only be called when Active is true.