UseDirectoryEmptyCheck Property

Whether the IsDirectoryEmpty event should be used.

Syntax

 cbfs.getUseDirectoryEmptyCheck([callback])
 cbfs.setUseDirectoryEmptyCheck( useDirectoryEmptyCheck, [callback])

Default Value

TRUE

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 getUseDirectoryEmptyCheck([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 setUseDirectoryEmptyCheck([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 specifies whether the class should fire the IsDirectoryEmpty event when the OS needs to check whether a directory is empty. Such checks are typically performed just before the OS requests that a directory be deleted.

If this property is enabled (default), the application must properly handle the IsDirectoryEmpty event.

Note that use of the IsDirectoryEmpty event is only efficient if the virtual filesystem has a fast way to check whether directories contain any entries (files, subdirectories, links). If such a check would require enumerating child entries, it's more efficient for the application to disable this property and perform the check directly within the CanFileBeDeleted event instead.

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

Boolean