use_hard_links Property

Whether the virtual filesystem supports hard links.

Syntax

def get_use_hard_links() -> bool: ...
def set_use_hard_links(value: bool) -> None: ...

use_hard_links = property(get_use_hard_links, set_use_hard_links)

Default Value

FALSE

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 on_create_hard_link, on_enumerate_hard_links, and on_close_hard_links_enumeration events in order for hard links to function correctly. The on_get_file_name_by_file_id event must be handled as well, and the on_get_file_info 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 file_system_name) 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.