UseAlternateDataStreams Property

Whether the virtual filesystem supports alternate data streams.

Syntax

 cbfs.getUseAlternateDataStreams([callback])
 cbfs.setUseAlternateDataStreams( useAlternateDataStreams, [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 getUseAlternateDataStreams([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 setUseAlternateDataStreams([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 alternate data streams (ADS, otherwise known as "named streams"). Alternate data streams can be present in both files and directories.

If this property is enabled, the application must properly handle the EnumerateNamedStreams and CloseNamedStreamsEnumeration events in order for alternate data streams to function correctly. Additionally, the application's GetFileInfo and EnumerateDirectory event handlers must take into account requests made by the OS to work with the alternate data streams.

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

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

Data Type

Boolean