on_before_create_hard_link Event
Fires before a hard link is created.
Syntax
class CBFilterBeforeCreateHardLinkEventParams(object): @property def file_name() -> str: ... @property def link_name() -> str: ... @property def replace_if_exists() -> bool: ... @replace_if_exists.setter def replace_if_exists(value) -> None: ... @property def file_context() -> int: ... @file_context.setter def file_context(value) -> None: ... @property def handle_context() -> int: ... @handle_context.setter def handle_context(value) -> None: ... @property def process_request() -> bool: ... @process_request.setter def process_request(value) -> None: ... @property def result_code() -> int: ... @result_code.setter def result_code(value) -> None: ... # In class CBFilter: @property def on_before_create_hard_link() -> Callable[[CBFilterBeforeCreateHardLinkEventParams], None]: ... @on_before_create_hard_link.setter def on_before_create_hard_link(event_hook: Callable[[CBFilterBeforeCreateHardLinkEventParams], None]) -> None: ...
Remarks
This event fires before a hard link to the file specified by FileName is created. Please refer to Microsoft's Hard Links article for more information about hard links.
Applications may use this event to modify the request's parameters, or to block the request entirely. To do the latter, set ProcessRequest to False.
Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_BEFORE_CREATE_HARD_LINK flag.
The LinkName parameter reflects the name of the new hard link.
The ReplaceIfExists parameter specifies what to do if a hard link with the specified LinkName already exists. If this parameter is True, the new hard link will replace the existing hard link; if this parameter is False, the operation will fail.
The FileContext and HandleContext parameters are placeholders for application-defined data associated with the file and specific handle, respectively. Please refer to the Contexts topic for more information.
The ProcessRequest parameter controls whether the request is sent onwards for further processing by subsequent filter drivers and the filesystem; it is True by default.
The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.
This event is fired synchronously; please refer to the Event Types topic for more information.