UseHardLinks Property

Whether the virtual filesystem supports hard links.

Syntax

 cbfs.getUseHardLinks([callback])
 cbfs.setUseHardLinks( useHardLinks, [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 getUseHardLinks([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 setUseHardLinks([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 hard links to files.

If this property is enabled, the application must properly handle the CreateHardLink, EnumerateHardLinks, and CloseHardLinksEnumeration events in order for hard links to function correctly. The GetFileNameByFileId event must be handled as well, and the GetFileInfo must always be sure to return the number of hard links a file has by setting the HardLinkCount event parameter appropriately.

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

Please refer to the Hard Links topic for more information.

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

Data Type

Boolean