UseWindowsSecurity Property

Whether the virtual filesystem supports Windows' ACL-based security mechanisms.

Syntax

 cbfs.getUseWindowsSecurity([callback])
 cbfs.setUseWindowsSecurity( useWindowsSecurity, [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 getUseWindowsSecurity([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 setUseWindowsSecurity([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 virtual filesystem should indicate to the system that it supports Windows' standard security mechanisms, which are based on ACLs (access control lists).

If this property is enabled, the application must properly handle the GetFileSecurity and SetFileSecurity events in order for Windows security mechanisms to function properly.

Note that Windows security attributes are an expected feature of the NTFS filesystem; if the application is identifying its virtual filesystem (via FileSystemName) as NTFS, supporting Windows security attributes is recommended.

Please refer to the Security Checks topic for more information.

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

Data Type

Boolean