CBFilter Class

Properties Methods Events Config Settings Errors

The CBFilter class allows applications to intercept and control filesystem requests.

Syntax

class cbfsfilter.CBFilter

Remarks

The CBFilter class gives applications the ability to intercept filesystem requests, allowing them to be altered, handled, or blocked. Applications use standard filter rules to specify which requests they are interested in intercepting; and special filter rules to enforce access restrictions and redirect requests to different files.

To learn more about the class's capabilities, please refer to the product's General Information topics.

Getting Started

If the class's system driver has not been installed yet, call the install method to do so. This needs to be done only once.
- In production, the driver can be installed (or updated) ahead of time with the application's installation script using the Installer DLL. Please refer to the Driver Installation topic for more information.
Call the initialize method to initialize the CBFilter class. This must be done each time the application starts.
Add one or more filter rules using methods like add_filter_rule. (Rules can also be added or removed after the filter is started.)
Call the start_filter method to start filtering filesystem requests.
When finished, call the stop_filter method to stop filtering filesystem requests.
To uninstall the class's system driver, call the uninstall method. This should not be done as part of the driver upgrade process.
- In production, the driver can be uninstalled by the application's uninstallation script using the Installer DLL. Please refer to the Driver Installation topic for more information.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


active	This property notes whether the class is active and processing requests.
altitude	This property specifies the altitude the class's system driver should use .
default_rule_count	The number of records in the DefaultRule arrays.
default_rule_access_flags	This property indicates the access restrictions enforced by the rule.
default_rule_mask	This property indicates a file mask that determines which files and directories match the rule.
file_flushing_behavior	This property specifies the file flushing and closing behavior that the class's system driver should enforce.
filter_rule_count	The number of records in the FilterRule arrays.
filter_rule_access_flags	This property indicates the access restrictions enforced by the rule (CBFilter only).
filter_rule_control_flags	This property indicates which control events the rule causes the class to fire (CBFilter only).
filter_rule_ea_name	This property indicates the name of an extended attribute that a file or directory must have to match the rule.
filter_rule_excluded_attributes	This property indicates the file attributes that a file or directory must not have to match the rule.
filter_rule_included_attributes	This property indicates the file attributes that a file or directory must have to match the rule.
filter_rule_mask	This property indicates a file mask that determines which files and directories match the rule.
filter_rule_max_size	This property indicates the maximum size a file can be to match the rule.
filter_rule_min_size	This property indicates the minimum size a file can be to match the rule.
filter_rule_notify_flags	This property indicates which notification events the rule causes the class to fire.
fire_volume_events	This property specifies the events that should be fired when a filesystem volume is mounted to or unmounted from the system.
normalize_short_file_names	CBFILTER_NORMALIZE_SHORT_FILE_NAMES_NEVER 0 CBFILTER_NORMALIZE_SHORT_FILE_NAMES_LOCAL_FS 1 CBFILTER_NORMALIZE_SHORT_FILE_NAMES_ALWAYS 2, TBD.
passthrough_rule_count	The number of records in the PassthroughRule arrays.
passthrough_rule_access_flags	This property specifies the access restrictions lifted by the rule (CBFilter only).
passthrough_rule_control_flags	This property indicates which control events the rule prevents the class from firing (CBFilter only).
passthrough_rule_ea_name	This property indicates the name of an extended attribute that a file or directory must have to match the rule.
passthrough_rule_excluded_attributes	This property indicates the file attributes that a file or directory must not have to match the rule.
passthrough_rule_included_attributes	This property indicates the file attributes that a file or directory must have to match the rule.
passthrough_rule_mask	This property indicates a file mask that determines which files and directories match the rule.
passthrough_rule_max_size	This property indicates the maximum size a file can be to match the rule.
passthrough_rule_min_size	This property indicates the minimum size a file can be to match the rule.
passthrough_rule_notify_flags	This property indicates which notification events the rule prevents the class from firing.
process_cached_io_requests	This property specifies whether cached file read/write requests should be processed.
process_failed_requests	This property specifies whether failed requests should be processed.
reparse_rule_count	The number of records in the ReparseRule arrays.
reparse_rule_mask	This property indicates a file mask that determines which files and directories match the rule.
reparse_rule_reparse_mask	This property contains a file mask that specifies where matching files and directories are redirected to.
serialize_events	Whether events should be fired on a single worker thread, or many.
tag	This property stores application-defined data specific to a particular instance of the class.
virtual_file_count	The number of records in the VirtualFile arrays.
virtual_file_attributes	This property specifies various attributes of a virtual file.
virtual_file_change_time	This property contains the time of the latest update of the metadata of a virtual file.
virtual_file_creation_time	This property contains the time of creation of a virtual file.
virtual_file_last_access_time	This property contains the time of the latest access to a virtual file.
virtual_file_last_write_time	This property contains the time of the latest modification of the data of a virtual file.
virtual_file_name	This property contains the name name of a virtual file.
virtual_file_nt_native_name	This property contains the name name of a virtual file in NT native format.
virtual_file_size	This property specifies the size of a virtual file.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


add_default_rule	This method adds a default rule.
add_filter_rule	This method adds a standard filter rule or access rule.
add_filter_rule_ex	This method adds a standard filter rule or access rule with additional match qualifiers.
add_passthrough_rule	This method adds a passthrough rule.
add_passthrough_rule_ex	This method adds a passthrough rule with additional match qualifiers.
add_reparse_rule	This method adds a reparse rule.
add_virtual_file	This method adds a virtual file to the list of virtual entries and makes it visible in the filesystem.
close_default_rules_snapshot	This method closes the previously created default rules snapshot.
close_reparse_rules_snapshot	This method closes the previously created reparse rules snapshot.
config	Sets or retrieves a configuration setting.
create_default_rules_snapshot	This method creates a snapshot of information about the default rules that have been added.
create_file_direct	This method creates or opens a file or directory by passing the request directly to the filesystem.
create_file_direct_as_stream	This method creates or opens a file by passing the request directly to the filesystem.
create_reparse_rules_snapshot	This method creates a snapshot of information about the reparse rules that have been added.
delete_all_filter_rules	This method deletes all standard filter rules and access rules.
delete_all_passthrough_rules	This method deletes all passthrough rules.
delete_all_reparse_rules	This method deletes all reparse rules.
delete_default_rule	This method deletes a particular default rule.
delete_filter_rule	This method deletes a particular standard filter rule or access rule.
delete_passthrough_rule	This method deletes a particular passthrough rule.
delete_reparse_rule	This method deletes a particular reparse rule.
file_matches_mask	This method checks whether a particular file or directory name matches the specified mask.
get_driver_status	This method retrieves the status of the class's system driver.
get_driver_version	This method retrieves the version of the class's system driver.
get_event_file_name	This method retrieves the name of the file or directory, to which the event applies.
get_handle_creator_process_id	This method retrieves the Id of the process (PID) that opened the file handle.
get_handle_creator_process_name	This method retrieves the name of the process that opened the file handle.
get_handle_creator_thread_id	This method retrieves the Id of the thread that opened the file handle.
get_handle_creator_token	This method retrieves the security token associated with the process that opened the file handle.
get_operation_time	This method returns the time at which the request was received by the filter driver.
get_originator_process_id	Retrieves the Id of the process (PID) that initiated the operation.
get_originator_process_name	Retrieves the name of the process that initiated the operation.
get_originator_thread_id	Retrieves the Id of the thread that initiated the operation.
get_originator_token	Retrieves the security token associated with the process that initiated the operation.
get_remote_access_information	This method returns networking-related information about the operation.
get_reparse_rule_by_mask	This method retrieves the reparse rule associated with the specified file mask.
get_volume_guid	This method retrieves the volume GUID of the device targeted by a filesystem operation.
initialize	This method initializes the class.
install	This method installs (or upgrades) the class's system driver.
is_file_filtered	This method checks whether a particular file or directory is covered by any filter rules.
nt_status_to_win32_error	This method converts a native status code to a Win32 error code.
query_file_information_direct	This method returns various kinds of information about a file object.
query_file_security_direct	This method retrieves security information of a file.
remove_virtual_file	This method removes a virtual file from the list of virtual entries.
reset_timeout	This method resets the timeout duration for the current event handler.
set_file_information_direct	This method sets the file information of a file opened using CreateFileDirect.
set_file_security_direct	This method sets security information of a file.
set_file_size_direct	This method resizes a file by passing the request directly to the filesystem.
shutdown_system	Shuts down or reboots the operating system.
start_filter	This method starts filtering filesystem operations.
stop_filter	This method stops filtering filesystem operations.
suspend_default_rules	This method suspends all default rules until the application exits.
suspend_file_events	This method suspends all events for a particular file or directory until all of its handles have been closed.
toggle_process_protection	This method enables or disables termination protection for the application.
uninstall	This method uninstalls the class's system driver.
update_virtual_file	This method updates known information about a virtual file .

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_after_can_file_be_deleted	This event fires after the OS marks a file or directory for deletion or removes such a mark.
on_after_cleanup_file	This event fires after a file or directory handle is closed.
on_after_close_enumeration	This event fires after a directory enumeration operation finishes.
on_after_close_file	This event fires after a file or directory is closed.
on_after_create_file	This event fires after a file or directory is created.
on_after_create_hard_link	This event fires after a hard link is created.
on_after_delete_file	This event fires after a file or directory is deleted.
on_after_delete_reparse_point	This event fires after the OS deletes a reparse point from a file or directory.
on_after_enumerate_directory	This event fires after a directory entry is returned during directory enumeration.
on_after_filter_attach_to_volume	This event fires after the filter attaches to a newly mounted filesystem volume.
on_after_filter_detach_from_volume	This event fires after the filter detaches from a filesystem volume.
on_after_fsctl	This event fires after an IRP_MJ_FILE_SYSTEM_CONTROL request is processed.
on_after_get_file_security	This event fires after a file or directory's security attributes are retrieved.
on_after_get_file_sizes	This event fires after a file's size information is retrieved.
on_after_get_reparse_point	This event fires after a file or directory's reparse point information is retrieved.
on_after_ioctl	This event fires after an IRP_MJ_DEVICE_CONTROL request is processed.
on_after_lock	This event fires after a range of bytes in a file is locked.
on_after_open_file	This event fires after a file or directory is opened.
on_after_query_ea	This event fires after information about extended attributes of a file is retrieved.
on_after_query_file_info	This event fires after information about a file or directory is retrieved.
on_after_read_file	This event fires after data are read from a file.
on_after_rename_or_move_file	This event fires after a file or directory is renamed or moved.
on_after_set_allocation_size	This event fires after a file's allocation size is changed.
on_after_set_ea	This event fires after extended attributes of a file are changed.
on_after_set_file_attributes	This event fires after a file or directory's attributes or times are changed.
on_after_set_file_info	This event fires after information about a file or directory is changed.
on_after_set_file_security	This event fires after a file or directory's security attributes are changed.
on_after_set_file_size	This event fires after a file is resized.
on_after_set_reparse_point	This event fires after the OS creates or updates a reparse point on a file or directory.
on_after_unlock_all	This event fires after all locked byte ranges in a file are unlocked.
on_after_unlock_all_by_key	This event fires after all locked byte ranges in a file, associated with a particular key, are unlocked.
on_after_unlock_single	This event fires after a particular locked byte range in a file is unlocked.
on_after_write_file	This event fires after data are written to a file.
on_before_can_file_be_deleted	This event fires before the OS attempts to mark a file or directory for deletion or remove such a mark.
on_before_cleanup_file	This event fires before a file or directory handle is closed.
on_before_close_file	This event fires before a file or directory is closed.
on_before_create_file	This event fires before a file or directory is created.
on_before_create_hard_link	This event fires before a hard link is created.
on_before_delete_file	This event fires before a file or directory is deleted.
on_before_delete_reparse_point	This event fires when the OS wants to delete a reparse point from a file or directory.
on_before_enumerate_directory	This event fires when an enumeration request is sent by the OS.
on_before_filter_attach_to_volume	This event fires before the filter attaches to a newly mounted filesystem volume.
on_before_fsctl	This event fires before an IRP_MJ_FILE_SYSTEM_CONTROL request is processed.
on_before_get_file_security	This event fires before a file or directory's security attributes are retrieved.
on_before_get_reparse_point	This event fires when the OS wants to read a reparse point for a file or directory.
on_before_ioctl	This event fires before an IRP_MJ_DEVICE_CONTROL request is processed.
on_before_lock	This event fires before a range of bytes in a file is locked.
on_before_open_file	This event fires before a file or directory is opened.
on_before_query_ea	This event fires before information about extended attributes of a file is retrieved.
on_before_query_file_info	This event fires before information about a file or directory is retrieved.
on_before_read_file	This event fires before data are read from a file.
on_before_rename_or_move_file	This event fires before a file or directory is renamed or moved.
on_before_set_allocation_size	This event fires before a file's allocation size is changed.
on_before_set_ea	This event fires before extended attributes of a file are changed.
on_before_set_file_attributes	This event fires before a file or directory's attributes or times are changed.
on_before_set_file_info	This event fires before information about a file or directory is changed.
on_before_set_file_security	This event fires before a file or directory's security attributes are changed.
on_before_set_file_size	This event fires before a file is resized.
on_before_set_reparse_point	This event fires when the OS wants to create or update a reparse point on a file or directory.
on_before_unlock_all	This event fires before all locked byte ranges in a file are unlocked.
on_before_unlock_all_by_key	This event fires before all locked byte ranges in a file, associated with a particular key, are unlocked.
on_before_unlock_single	This event fires before a particular locked byte range in a file is unlocked.
on_before_write_file	This event fires before data are written to a file.
on_bypass_io_request	This event fires when the OS sends one of BypassIO commands.
on_cleanup_context	This event fires when the application-defined data stored in one or more contexts need to be cleaned up.
on_error	This event fires if an unhandled error occurs during an event.
on_filter_start	This event fires once the filter has attached and filtering has started.
on_filter_stop	This event fires once filtering has stopped and the filter has detached.
on_notify_can_file_be_deleted	This event fires when the OS marks a file or directory for deletion or removes such a mark.
on_notify_cleanup_file	This event fires when a file or directory handle has been closed.
on_notify_close_file	This event fires when a file or directory has been closed.
on_notify_create_file	This event fires when a file or directory has been created.
on_notify_create_hard_link	This event fires when a hard link has been created.
on_notify_delete_file	This event fires when a file or directory has been deleted.
on_notify_delete_reparse_point	This event fires when a file or directory's reparse point has been deleted.
on_notify_enumerate_directory	This event fires when a directory entry has been returned during directory enumeration.
on_notify_filter_attach_to_volume	This event fires when the filter has been attached to a newly mounted filesystem volume.
on_notify_filter_detach_from_volume	This event fires when the filter has been detached from a filesystem volume.
on_notify_fsctl	This event fires when an IRP_MJ_FILE_SYSTEM_CONTROL operation has occurred.
on_notify_get_file_security	This event fires when a file or directory's security attributes have been retrieved.
on_notify_get_file_sizes	This event fires when a file's size information has been retrieved.
on_notify_get_reparse_point	This event fires when a file or directory's reparse point information has been retrieved.
on_notify_ioctl	This event fires when an IRP_MJ_DEVICE_CONTROL operation has occurred.
on_notify_lock	This event fires when a range of bytes in a file has been locked.
on_notify_open_file	This event fires when a file or directory has been opened.
on_notify_query_ea	This event fires when information about the extended attributes of a file has been retrieved.
on_notify_query_file_info	This event fires when information about a file or directory has been retrieved.
on_notify_read_file	This event fires when data have been read from a file.
on_notify_rename_or_move_file	This event fires when a file or directory has been renamed or moved.
on_notify_set_allocation_size	This event fires when a file's allocation size has been changed.
on_notify_set_ea	This event fires when information about the extended attributes of a file has been changed.
on_notify_set_file_attributes	This event fires when a file or directory's attributes or times have been changed.
on_notify_set_file_info	This event fires when information about a file or directory has been changed.
on_notify_set_file_security	This event fires when a file or directory's security attributes have been changed.
on_notify_set_file_size	This event fires when a file has been resized.
on_notify_set_reparse_point	This event fires when a file or directory's reparse point has been created or updated.
on_notify_unlock_all	This event fires when all locked byte ranges in a file have been unlocked.
on_notify_unlock_all_by_key	This event fires when all locked byte ranges in a file, associated with a particular key, have been unlocked.
on_notify_unlock_single	This event fires when a particular locked byte range in a file has been unlocked.
on_notify_write_file	This event fires when data have been written to a file.
on_reparse_file_name	This event fires to allow file access to be dynamically redirected to another location.
on_reparse_with_tag	This event fires if an open operation returns STATUS_REPARSE so that the application can respond to the reparse point.
on_worker_thread_creation	Fires just after a new worker thread is created.
on_worker_thread_termination	Fires just before a worker thread is terminated.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


AllowFileAccessInBeforeOpen	Whether file access, via the CreateFileDirect method, is allowed in during the BeforeCreateFile and BeforeOpenFile events.
AlwaysPrepareFiles	Whether the driver should keep track of information for files that are already open when (i.e., were opened before) the class is initialized.
AlwaysRequestAttributesOnOpen	Whether the driver should keep request existing attributes before file create/open operation.
CacheRemoteFilesLocally	Whether remote files involved in filtered operations should be cached locally rather than remotely.
FilterOwnRequests	Whether the class's system driver should filter requests made by the application itself.
ForceAdminRightsForDefaultRules	Specifies whether default rules can be added or deleted only by administrators.
ForceAppPermissionCheck	Whether the driver should require the controller process to have elevated or system privileges.
ForceSecurityChecks	Whether the driver should prevent the controller process from filtering files that it would not normally have access to.
LoggingEnabled	Whether extended logging is enabled.
MaxWorkerThreadCount	The maximum number of worker threads to use to fire events.
MinWorkerThreadCount	The minimum number of worker threads to use to fire events.
ModifiableReadWriteBuffers	Whether the driver should duplicate read/write buffers sent to the user.
NormalizeShortFileNames	Whether the driver should attempt to resolve short file names and convert them to regular ones.
OmitEventFileNames	Whether the filename parameter should be empty in events.
PassAllFileNames	Whether the driver should pass all known names of a file, including hardlinks and previous names, to event handlers.
PassSecurityInFileOpenEvents	Whether security information, associated with the file create/open request, is passed to file creation and opening events.
PreprocessedRulesCacheSize	Maximum number of preprocessed rules to keep cached.
RecordOperationTime	Enables collection of operation time.
ResolveNtDeviceToDriveLetter	Whether native device names are translated to drive letters.
RetriveLinkNamesOnOpen	Specifies that the driver should collect all hard links when a file is opened.
SendRequestsViaDriverStack	Whether internal requests to the filesystem are sent directly to the filesystem driver or through the stack of filesystem filter drivers.
SerializeAccess	Whether nonintersecting operations against the same file should execute serially or in parallel.
TranslateDOSCharsInEnumMasks	Whether the DOS wildcard characters should be translated during search.
WorkerInitialStackSize	The initial stack size to create worker threads with.
BuildInfo	Information about the product's build.
LicenseInfo	Information about the current license.

active Property

This property notes whether the class is active and processing requests.

Syntax

def get_active() -> bool: ...

active = property(get_active, None)

Default Value

FALSE

Remarks

This property reflects whether the class is active and currently processing requests. It will be True after the filter has been attached successfully via a call to start_filter.

This property is read-only.

altitude Property

This property specifies the altitude the class's system driver should use .

Syntax

def get_altitude() -> str: ...
def set_altitude(value: str) -> None: ...

altitude = property(get_altitude, set_altitude)

Default Value

Remarks

This property specifies the altitude that the class's system driver should use . A driver's altitude determines its absolute position in the stack of filter drivers; drivers with higher altitudes are attached toward the top of the stack, closer to the user mode, which allows them to process requests earlier.

Microsoft manages and assigns filesystem minifilter driver altitudes directly, so an application-specific altitude value must be obtained from Microsoft before an application is deployed in production. Please refer to the Driver Altitudes topic for more information. During development, an appropriate arbitrary value, such as 360000 (which is not registered with Microsoft), can be used.

If this property is queried before an altitude has been set (via this property or the install method), it will return an empty string.

Note: This property cannot be changed when active is True. Additionally, the initialize method must be called before attempting to get or set this property's value, which is stored in the registry.

default_rule_count Property

The number of records in the DefaultRule arrays.

Syntax

def get_default_rule_count() -> int: ...

default_rule_count = property(get_default_rule_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

default_rule_access_flags
default_rule_mask

The array indices start at 0 and end at default_rule_count - 1.

This property is read-only.

default_rule_access_flags Property

This property indicates the access restrictions enforced by the rule.

Syntax

def get_default_rule_access_flags(default_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the access restrictions enforced by the rule.

This property indicates which access restrictions are enforced by the rule. Please refer to the Default Rules topic for more information. The value of this property is a combination of zero or more of the following:


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

The default_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the default_rule_count property.

This property is read-only.

default_rule_mask Property

This property indicates a file mask that determines which files and directories match the rule.

Syntax

def get_default_rule_mask(default_rule_index: int) -> str: ...

Default Value

Remarks

This property indicates a file mask that determines which files and directories match the rule.

This property reflects the file mask used to determine whether a file or directory matches the rule. In addition to being its primary match qualifier, a rule's mask also serves as its identifier; every rule in a ruleset must have a unique mask.

Note: When a rule with a drive letter is added, said drive letter is automatically converted to NT Device format. When the ResolveNtDeviceToDriveLetter configuration setting is disabled, this property's value will contain the NT Device name. When the ResolveNtDeviceToDriveLetter configuration setting is enabled, the class attempts to convert the mask back to the DOS format with a drive letter. In some situations, such backward conversion can lead to a path that was different from the original path added.

The default_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the default_rule_count property.

This property is read-only.

file_flushing_behavior Property

This property specifies the file flushing and closing behavior that the class's system driver should enforce.

Syntax

def get_file_flushing_behavior() -> int: ...
def set_file_flushing_behavior(value: int) -> None: ...

file_flushing_behavior = property(get_file_flushing_behavior, set_file_flushing_behavior)

Default Value

Remarks

This property specifies what file flushing and closing behaviors the class's system driver should enforce.

Applications that modify file data as it is being read or written may need to change this property's value to function correctly. For example, applications that provide on-the-fly encryption should choose the proper flags to ensure that other applications that have opened the files being encrypted cannot accidentally write nonencrypted data to the disk.

Applications that do not modify file data as it is being read or written can leave this property unchanged.

The value of this property should be constructed by ORing together zero or more of the following flags:


FS_FLUSH_FILES_ON_OPEN	`1`	Whether memory-mapped file data should be flushed to disk before files are opened. This flag indicates that the class's system driver should flush any cached and memory-mapped file data, leftover from the last time a file was opened, before opening it again. Doing so ensures that file data are read directly from the disk rather than from the old memory mapping. Applications that modify file data as it is being read may need to set this flag to function correctly. For example, applications that provide on-the-fly encryption should set this flag to ensure that file data are always read from the disk (and thus have a chance to get decrypted) when a file is opened. Applications that do not modify file data as it is being read should leave this flag unset to maintain optimal performance when opening files.
FS_FLUSH_FILES_ON_CLOSE	`2`	Whether file buffers must be flushed when files are closed. This flag indicates that the class's system driver should flush and clear the buffers of files that are opened for writing (and have had data written to them) when they are closed. Applications that modify file data as it is being written may need to set this flag to function correctly. For example, applications that provide on-the-fly encryption should set this flag to ensure that all file data are flushed to the disk (and thus has a chance to get encrypted) when a file is closed. Applications that do not modify file data as it is being written can unset this flag. After a file is flushed, all in-memory buffers and memory mappings are cleared to avoid leakage of unprotected information.
FS_CLOSE_FILES_ON_STOPFILTER	`4`	Whether files opened for writing must be closed when the application stops filtering. This flag indicates that the class's system driver should close files that are opened for writing (and have had data written to them) when the application calls stop_filter. Applications that modify file data as it is being written (e.g., on-the-fly encryption) may need to set this flag to prevent further operations against the file data from being performed. Applications that do not modify file data as it is being written can leave this flag unset. Note: If memory mappings of some file exist, these mappings will remain active; only the open handles to such files are closed. When the file is closed, all in-memory buffers and memory mappings are cleared to avoid leakage of unprotected information. Applications can control whether file data are flushed before files are closed using the `FS_FLUSH_FILES_ON_STOPFILTER` flag; any data that are not flushed get discarded.
FS_FLUSH_FILES_ON_STOPFILTER	`8`	Whether file buffers must be flushed when the application stops filtering. This flag indicates that the class's system driver should flush and clear the buffers of files that are opened for writing (and have had data written to them) when the application calls stop_filter. Applications that modify file data as it is being written (e.g., on-the-fly encryption) may need to set this flag to ensure that no unprotected data are kept in memory, but rather has a chance to be encrypted and written out to disk. Applications that do not modify file data as it is being written can leave this flag unset. If the application will not be able to perform on-the-fly data modification at the moment when stop_filter is called (e.g., because a cryptographic hardware module is unplugged), then this flag should be unset before calling stop_filter. After a file is flushed, all in-memory buffers and memory mappings are cleared to avoid leakage of unprotected information.
FS_CLOSE_FILES_ON_CRASH	`16`	Whether files opened for writing must be closed if the application terminates unexpectedly. This flag indicates that the class's system driver should close files that are opened for writing (and have had data written to them) if the driver detects that the application has terminated. Applications that modify file data as it is being written (e.g., on-the-fly encryption) may need to set this flag to prevent further operations against the file data from being performed. Applications that do not modify file data as it is being written can leave this flag unset. Note: If memory mappings of some file exist, these mappings will remain active; only the open handles to such files are closed. When the file is closed, all in-memory buffers and memory mappings are cleared to avoid leakage of unprotected information.
FS_FLUSH_FILES_ON_CRASH	`32`	Whether file buffers must be flushed if the application terminates unexpectedly. This flag indicates that the class's system driver should flush and clear the buffers of files that are opened for writing (and have had data written to them) if the driver detects that the application has terminated. Applications that do not modify data as it is being written may set this flag if necessary. Applications that modify data as it is being written (e.g., on-the-fly encryption) should not set this flag, because such flushing could cause unprotected data to be written out to disk.
FS_SUPPORT_FILE_ENCRYPTION	`31`	Combination of flags suitable for on-the-fly file encryption applications. This option includes the following flags: `FS_FLUSH_FILES_ON_OPEN`, `FS_FLUSH_FILES_ON_CLOSE`, `FS_CLOSE_FILES_ON_STOPFILTER`, `FS_FLUSH_FILES_ON_STOPFILTER`, and `FS_CLOSE_FILES_ON_CRASH` flags.

filter_rule_count Property

The number of records in the FilterRule arrays.

Syntax

def get_filter_rule_count() -> int: ...

filter_rule_count = property(get_filter_rule_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

filter_rule_access_flags
filter_rule_control_flags
filter_rule_ea_name
filter_rule_excluded_attributes
filter_rule_included_attributes
filter_rule_mask
filter_rule_max_size
filter_rule_min_size
filter_rule_notify_flags

The array indices start at 0 and end at filter_rule_count - 1.

This property is read-only.

filter_rule_access_flags Property

This property indicates the access restrictions enforced by the rule (CBFilter only).

Syntax

def get_filter_rule_access_flags(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the access restrictions enforced by the rule (CBFilter only).

This property indicates which access restrictions are enforced by the rule. Please refer to the Access Rules topic for more information. The value of this property is a combination of zero or more of the following:


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

Note: This property is always 0 for the CBMonitor class, which does not support access rules.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_control_flags Property

This property indicates which control events the rule causes the class to fire (CBFilter only).

Syntax

def get_filter_rule_control_flags(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates which control events the rule causes the class to fire (CBFilter only).

This property indicates which filesystem operations, of those performed on matching files and directories, the class should fire Control Events for. The value of this property is a combination of zero or more of the following:


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.

Note: This property is always 0 for the CBMonitor class, which does not provide any Control Events for filesystem operations.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_ea_name Property

This property indicates the name of an extended attribute that a file or directory must have to match the rule.

Syntax

def get_filter_rule_ea_name(filter_rule_index: int) -> str: ...

Default Value

Remarks

This property indicates the name of an extended attribute that a file or directory must have to match the rule.

This property reflects the name of an extended attribute that a file or directory must have to qualify as a match for the rule. A value of an empty string indicates that the rule does not use this property as a match qualifier.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_excluded_attributes Property

This property indicates the file attributes that a file or directory must not have to match the rule.

Syntax

def get_filter_rule_excluded_attributes(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the file attributes that a file or directory must not have to match the rule.

This property indicates which file attributes a file or directory must not have to qualify as a match for the rule. A value of 0 indicates that the rule does not use this property as a match qualifier.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_included_attributes Property

This property indicates the file attributes that a file or directory must have to match the rule.

Syntax

def get_filter_rule_included_attributes(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the file attributes that a file or directory must have to match the rule.

This property indicates which file attributes a file or directory must have to qualify as a match for the rule. A value of 0 indicates that the rule does not use this property as a match qualifier.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_mask Property

This property indicates a file mask that determines which files and directories match the rule.

Syntax

def get_filter_rule_mask(filter_rule_index: int) -> str: ...

Default Value

Remarks

This property indicates a file mask that determines which files and directories match the rule.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_max_size Property

This property indicates the maximum size a file can be to match the rule.

Syntax

def get_filter_rule_max_size(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the maximum size a file can be to match the rule.

This property indicates the maximum size, in bytes, that a file can be to qualify as a match for the rule. A value of -1 indicates that the rule does not use this property as a match qualifier.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_min_size Property

This property indicates the minimum size a file can be to match the rule.

Syntax

def get_filter_rule_min_size(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the minimum size a file can be to match the rule.

This property indicates the minimum size, in bytes, that a file can be to qualify as a match for the rule. A value of -1 indicates that the rule does not use this property as a match qualifier.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

filter_rule_notify_flags Property

This property indicates which notification events the rule causes the class to fire.

Syntax

def get_filter_rule_notify_flags(filter_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates which notification events the rule causes the class to fire.

This property indicates which filesystem operations, of those performed on matching files and directories, the class should fire Notification Events for. The value of this property is a combination of zero or more of the following:


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

The filter_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the filter_rule_count property.

This property is read-only.

fire_volume_events Property

This property specifies the events that should be fired when a filesystem volume is mounted to or unmounted from the system.

Syntax

def get_fire_volume_events() -> int: ...
def set_fire_volume_events(value: int) -> None: ...

fire_volume_events = property(get_fire_volume_events, set_fire_volume_events)

Default Value

Remarks

This property specifies the events that the class should fire when a filesystem volume is mounted to or unmounted from the system. Possible values are as follows:


FS_MOUNT_IGNORE	`0`	Don't fire any events when volumes are mounted or unmounted.
FS_MOUNT_NOTIFY	`64`	Fire Notification Events when volumes are mounted or unmounted. The on_notify_filter_attach_to_volume and on_notify_filter_detach_from_volume events will fire, asynchronously, as necessary.
FS_MOUNT_CONTROL	`128`	Fire Control Events when volumes are mounted or unmounted. The on_before_filter_attach_to_volume, on_after_filter_attach_to_volume, and on_after_filter_detach_from_volume events will fire, synchronously, as necessary.
FS_MOUNT_BOTH	`192`	Fire all events when volumes are mounted or unmounted.

Note: The aforementioned events are fired only for volumes mounted/unmounted after the start_filter method is called. Typically, applications use these events to dynamically add or remove volume-specific filter rules that target removable volumes (e.g., USB drives) as well as to create virtual files on such volumes. Please refer to the File Masks topic for more information.

normalize_short_file_names Property

CBFILTER_NORMALIZE_SHORT_FILE_NAMES_NEVER 0 CBFILTER_NORMALIZE_SHORT_FILE_NAMES_LOCAL_FS 1 CBFILTER_NORMALIZE_SHORT_FILE_NAMES_ALWAYS 2, TBD.

Syntax

def get_normalize_short_file_names() -> int: ...
def set_normalize_short_file_names(value: int) -> None: ...

normalize_short_file_names = property(get_normalize_short_file_names, set_normalize_short_file_names)

Default Value

Remarks

TBD.

passthrough_rule_count Property

The number of records in the PassthroughRule arrays.

Syntax

def get_passthrough_rule_count() -> int: ...

passthrough_rule_count = property(get_passthrough_rule_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

passthrough_rule_access_flags
passthrough_rule_control_flags
passthrough_rule_ea_name
passthrough_rule_excluded_attributes
passthrough_rule_included_attributes
passthrough_rule_mask
passthrough_rule_max_size
passthrough_rule_min_size
passthrough_rule_notify_flags

The array indices start at 0 and end at passthrough_rule_count - 1.

This property is read-only.

passthrough_rule_access_flags Property

This property specifies the access restrictions lifted by the rule (CBFilter only).

Syntax

def get_passthrough_rule_access_flags(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property specifies the access restrictions lifted by the rule (CBFilter only).

This property indicates which access restrictions are lifted by the rule. Please refer to the Passthrough Rules topic for more information. The value of this property is a combination of zero or more of the following:


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

Note: This property is always 0 for the CBMonitor class, which does not support access rules.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_control_flags Property

This property indicates which control events the rule prevents the class from firing (CBFilter only).

Syntax

def get_passthrough_rule_control_flags(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates which control events the rule prevents the class from firing (CBFilter only).

This property indicates which filesystem operations, of those performed on matching files and directories, the class should not fire Control Events for. Please refer to the Passthrough Rules topic for more information. The value of this property is a combination of zero or more of the following:


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.

Note: This property is always 0 for the CBMonitor class, which does not provide any Control Events for filesystem operations.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_ea_name Property

This property indicates the name of an extended attribute that a file or directory must have to match the rule.

Syntax

def get_passthrough_rule_ea_name(passthrough_rule_index: int) -> str: ...

Default Value

Remarks

This property indicates the name of an extended attribute that a file or directory must have to match the rule.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_excluded_attributes Property

This property indicates the file attributes that a file or directory must not have to match the rule.

Syntax

def get_passthrough_rule_excluded_attributes(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the file attributes that a file or directory must not have to match the rule.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_included_attributes Property

This property indicates the file attributes that a file or directory must have to match the rule.

Syntax

def get_passthrough_rule_included_attributes(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the file attributes that a file or directory must have to match the rule.

This property indicates which file attributes a file or directory must have to qualify as a match for the rule. A value of 0 indicates that the rule does not use this property as a match qualifier.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_mask Property

This property indicates a file mask that determines which files and directories match the rule.

Syntax

def get_passthrough_rule_mask(passthrough_rule_index: int) -> str: ...

Default Value

Remarks

This property indicates a file mask that determines which files and directories match the rule.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_max_size Property

This property indicates the maximum size a file can be to match the rule.

Syntax

def get_passthrough_rule_max_size(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the maximum size a file can be to match the rule.

This property indicates the maximum size, in bytes, that a file can be to qualify as a match for the rule. A value of -1 indicates that the rule does not use this property as a match qualifier.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_min_size Property

This property indicates the minimum size a file can be to match the rule.

Syntax

def get_passthrough_rule_min_size(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates the minimum size a file can be to match the rule.

This property indicates the minimum size, in bytes, that a file can be to qualify as a match for the rule. A value of -1 indicates that the rule does not use this property as a match qualifier.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

passthrough_rule_notify_flags Property

This property indicates which notification events the rule prevents the class from firing.

Syntax

def get_passthrough_rule_notify_flags(passthrough_rule_index: int) -> int: ...

Default Value

Remarks

This property indicates which notification events the rule prevents the class from firing.

This property indicates which filesystem operations, of those performed on matching files and directories, the class should not fire Notification Events for. Please refer to the Passthrough Rules topic for more information. The value of this property is a combination of zero or more of the following:


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

The passthrough_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the passthrough_rule_count property.

This property is read-only.

process_cached_io_requests Property

This property specifies whether cached file read/write requests should be processed.

Syntax

def get_process_cached_io_requests() -> bool: ...
def set_process_cached_io_requests(value: bool) -> None: ...

process_cached_io_requests = property(get_process_cached_io_requests, set_process_cached_io_requests)

Default Value

FALSE

Remarks

This property specifies whether the class's system driver should process cached file read/write requests (i.e., fire *ReadFile and *WriteFile events for them). Please refer to the Cached and Non-Cached Requests topic for more information.

Note: This property cannot be changed when active is True.

process_failed_requests Property

This property specifies whether failed requests should be processed.

Syntax

def get_process_failed_requests() -> bool: ...
def set_process_failed_requests(value: bool) -> None: ...

process_failed_requests = property(get_process_failed_requests, set_process_failed_requests)

Default Value

FALSE

Remarks

This property specifies whether the class's system driver should process failed requests (i.e., fire After* or Notify* events for them).

When this property is enabled, applications can inspect the Status parameter of the aforementioned events to determine whether an operation has failed. If an operation fails, then the corresponding event's Status parameter will contain a nonzero native status code. Applications generally can use the nt_status_to_win32_error method to convert these status codes into Win32 error codes (but keep in mind that not all native status codes have direct Win32 error code mapping).

reparse_rule_count Property

The number of records in the ReparseRule arrays.

Syntax

def get_reparse_rule_count() -> int: ...

reparse_rule_count = property(get_reparse_rule_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

reparse_rule_mask
reparse_rule_reparse_mask

The array indices start at 0 and end at reparse_rule_count - 1.

This property is read-only.

reparse_rule_mask Property

This property indicates a file mask that determines which files and directories match the rule.

Syntax

def get_reparse_rule_mask(reparse_rule_index: int) -> str: ...

Default Value

Remarks

This property indicates a file mask that determines which files and directories match the rule.

The reparse_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the reparse_rule_count property.

This property is read-only.

reparse_rule_reparse_mask Property

This property contains a file mask that specifies where matching files and directories are redirected to.

Syntax

def get_reparse_rule_reparse_mask(reparse_rule_index: int) -> str: ...

Default Value

Remarks

This property contains a file mask that specifies where matching files and directories are redirected to.

This property contains a file mask that specifies where files and directories that match reparse_rule_mask are redirected to. Please refer to the Reparse Rules topic for more information.

The reparse_rule_index parameter specifies the index of the item in the array. The size of the array is controlled by the reparse_rule_count property.

This property is read-only.

serialize_events Property

Whether events should be fired on a single worker thread, or many.

Syntax

def get_serialize_events() -> int: ...
def set_serialize_events(value: int) -> None: ...

serialize_events = property(get_serialize_events, set_serialize_events)

Default Value

Remarks

This property specifies whether the class should fire all events serially on a single worker thread, or concurrently on multiple worker threads. The possible values are:


0 (seOnMultipleThreads)	The class fires events in the context of multiple worker threads. The MinWorkerThreadCount and MaxWorkerThreadCount configuration settings control how many worker threads are used for this.
1 (seOnOneWorkerThread)	The class fires events in the context of one background worker thread.

Please refer to the Threading and Concurrency topic for more information.

Note: This property cannot be changed when active is True, and it cannot be changed within events.

tag Property

This property stores application-defined data specific to a particular instance of the class.

Syntax

def get_tag() -> int: ...
def set_tag(value: int) -> None: ...

tag = property(get_tag, set_tag)

Default Value

Remarks

This property can be used to store data specific to a particular instance of the class.

virtual_file_count Property

The number of records in the VirtualFile arrays.

Syntax

def get_virtual_file_count() -> int: ...

virtual_file_count = property(get_virtual_file_count, None)

Default Value

Remarks

This property controls the size of the following arrays:

virtual_file_attributes
virtual_file_change_time
virtual_file_creation_time
virtual_file_last_access_time
virtual_file_last_write_time
virtual_file_name
virtual_file_nt_native_name
virtual_file_size

The array indices start at 0 and end at virtual_file_count - 1.

This property is read-only.

virtual_file_attributes Property

This property specifies various attributes of a virtual file.

Syntax

def get_virtual_file_attributes(virtual_file_index: int) -> int: ...

Default Value

Remarks

This property specifies various attributes of a virtual file.

This property specifies the attributes of the virtual file. The initial value is set to the one provided when the file was added to the list using add_virtual_file. An application may update the values using the update_virtual_file.

Please refer to Microsoft's File Attribute Constants article for attribute descriptions.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_change_time Property

This property contains the time of the latest update of the metadata of a virtual file.

Syntax

def get_virtual_file_change_time(virtual_file_index: int) -> datetime.datetime: ...

Default Value

Remarks

This property contains the time of the latest update of the metadata of a virtual file.

This property contains the time of the latest update of the metadata of the virtual file, specified in UTC. The initial value is set to the one provided when the file was added to the list using add_virtual_file. An application may update the values using the update_virtual_file.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_creation_time Property

This property contains the time of creation of a virtual file.

Syntax

def get_virtual_file_creation_time(virtual_file_index: int) -> datetime.datetime: ...

Default Value

Remarks

This property contains the time of creation of a virtual file.

This property contains the time of creation of the virtual file, specified in UTC. The initial value is set to the one provided when the file was added to the list using add_virtual_file. An application may update the values using the update_virtual_file.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_last_access_time Property

This property contains the time of the latest access to a virtual file.

Syntax

def get_virtual_file_last_access_time(virtual_file_index: int) -> datetime.datetime: ...

Default Value

Remarks

This property contains the time of the latest access to a virtual file.

This property contains the time of the latest access to the virtual file, specified in UTC. The initial value is set to the one provided when the file was added to the list using add_virtual_file. An application may update the values using the update_virtual_file.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_last_write_time Property

This property contains the time of the latest modification of the data of a virtual file.

Syntax

def get_virtual_file_last_write_time(virtual_file_index: int) -> datetime.datetime: ...

Default Value

Remarks

This property contains the time of the latest modification of the data of a virtual file.

This property contains the time of the latest modification of the data of the virtual file, specified in UTC. The initial value is set to the one provided when the file was added to the list using add_virtual_file. An application may update the values using the update_virtual_file.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_name Property

This property contains the name name of a virtual file.

Syntax

def get_virtual_file_name(virtual_file_index: int) -> str: ...

Default Value

Remarks

This property contains the name name of a virtual file.

This property contains the path and the name of the added file as they were specified in a call to add_virtual_file. The name is converted to the NT native format internally when the file or directory is added to the list.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_nt_native_name Property

This property contains the name name of a virtual file in NT native format.

Syntax

def get_virtual_file_nt_native_name(virtual_file_index: int) -> str: ...

Default Value

Remarks

This property contains the name name of a virtual file in NT native format.

This property contains the path and the name of the added file; the contained path is in the NT native format.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

virtual_file_size Property

This property specifies the size of a virtual file.

Syntax

def get_virtual_file_size(virtual_file_index: int) -> int: ...

Default Value

Remarks

This property specifies the size of a virtual file.

This property specifies the size of the virtual file. The initial value is set to the one provided when the file was added to the list using add_virtual_file. An application may update the values using the update_virtual_file.

Please refer to Microsoft's File Attribute Constants article for attribute descriptions.

The virtual_file_index parameter specifies the index of the item in the array. The size of the array is controlled by the virtual_file_count property.

This property is read-only.

add_default_rule Method

This method adds a default rule.

Syntax

def add_default_rule(mask: str, access_flags: int, product_guid: str) -> bool: ...

Remarks

This method adds a default rule for the files and directories that match the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Default rules, like access rules, instruct the class's system driver to apply certain access restrictions to matching files and directories. However, unlike access rules, default rules are managed by the driver directly; they are activated as soon as the driver loads at boot time, and then continue to be enforced at all times, regardless of whether the application that added them is open.

The Mask parameter must be a valid file mask according to the File Masks topic. Only the files and directories that match the specified mask will be covered by the rule.

The AccessFlags parameter specifies which access restrictions the class's system driver should apply to matching files and directories. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

The ProductGUID parameter identifies the application that the rule should be associated with in the registry. In most cases, the value passed for this parameter should be the same one that was used to call the initialize method.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD (0x0522) error. Please refer to the Default Rules topic for more information.

Note: The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads (e.g., during the on_after_filter_attach_to_volume and on_after_filter_detach_from_volume events) are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists both occur in a thread-safe manner.

add_filter_rule Method

This method adds a standard filter rule or access rule.

Syntax

def add_filter_rule(mask: str, access_flags: int, control_flags: int, notify_flags: int) -> bool: ...

Remarks

This method adds a standard filter rule or access rule for the files and directories that match the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Standard filter rules determine which filesystem operations, of those performed on matching files and directories, the class should fire its events for. Access rules instruct the class's system driver to apply certain access restrictions to matching files and directories.

The Mask parameter must be a valid file mask according to the File Masks topic. Only the files and directories that match the specified mask will be covered by the rule.


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

The ControlFlags parameter specifies which filesystem operations the class should fire Control Events for. For example, if the FS_CE_BEFORE_READ and FS_CE_AFTER_READ flags are present, the on_before_read_file and on_after_read_file events will fire before and after a read operation is performed on any file that matches Mask. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.

The NotifyFlags parameter specifies which filesystem operations the class should fire Notification Events for. For example, if the FS_NE_READ flag is present, the on_notify_read_file event will fire after a read operation is performed on any file that matches Mask. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

add_filter_rule_ex Method

This method adds a standard filter rule or access rule with additional match qualifiers.

Syntax

def add_filter_rule_ex(mask: str, ea_name: str, access_flags: int, control_flags: int, notify_flags: int, min_size: int, max_size: int, included_attributes: int, excluded_attributes: int) -> bool: ...

Remarks

This method adds a standard filter rule or access rule for the files and directories that match the specified Mask (which must be provided), and other qualifiers (which are optional). Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be a valid file mask according to the File Masks topic. Only the files and directories that match the specified mask will be covered by the rule.

The EaName parameter specifies the name of an extended attribute that a file or directory must have to qualify as a match; wildcards are not allowed. Pass an empty string if this parameter should not be used as a match qualifier.


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

The MinSize and MaxSize parameters specify the minimum and maximum size, in bytes, that a file can be to qualify as a match. Pass -1 for either parameter if it should not be used as a match qualifier.

The IncludedAttributes and ExcludedAttributes parameters specify which file attributes a file or directory must have or not have to qualify as a match. Pass 0 for either parameter if it should not be used as a match qualifier.

add_passthrough_rule Method

This method adds a passthrough rule.

Syntax

def add_passthrough_rule(mask: str, access_flags: int, control_flags: int, notify_flags: int) -> bool: ...

Remarks

This method adds a passthrough rule for the files and directories that match the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Passthrough rules exclude matching files and directories from being processed by other filter rules.

The Mask parameter must be a valid file mask according to the File Masks topic. Only the files and directories that match the specified mask will be covered by the rule.

The AccessFlags parameter specifies which access restrictions the class's system driver should lift from matching files and directories. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

The ControlFlags parameter specifies which filesystem operations the class should not fire Control Events for. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.

The NotifyFlags parameter specifies which filesystem operations the class should not fire Notification Events for. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

add_passthrough_rule_ex Method

This method adds a passthrough rule with additional match qualifiers.

Syntax

def add_passthrough_rule_ex(mask: str, ea_name: str, access_flags: int, control_flags: int, notify_flags: int, min_size: int, max_size: int, included_attributes: int, excluded_attributes: int) -> bool: ...

Remarks

This method adds a passthrough rule for the files and directories that match the specified Mask (which must be provided) and other qualifiers (which are optional). Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule's parameters are merged into it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Passthrough rules exclude matching files and directories from being processed by other filter rules.

The Mask parameter must be a valid file mask according to the File Masks topic. Only the files and directories that match the specified mask will be covered by the rule.


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

add_reparse_rule Method

This method adds a reparse rule.

Syntax

def add_reparse_rule(mask: str, reparse_mask: str, product_guid: str, flags: int) -> bool: ...

Remarks

This method adds a reparse rule for the files and directories that match the specified Mask. Each rule in a ruleset is uniquely identified by its mask; if a rule with the specified mask already exists, the new rule replaces it.

If the rule is added successfully, this method returns True; otherwise, it returns False.

Reparse rules are used to redirect access from a file or directory covered by Mask to another location in the filesystem, specified by ReparseMask.

The Mask and ReparseMask parameters must be valid file masks according to the File Masks topic. Only the files and directories that match Mask will be covered by the rule (i.e., redirected to the path specified by ReparseMask). For example, passing *.txt for Mask and *_1.txt for ReparseMask would cause, for example, test.txt to be redirected to test_1.txt.

More generally, for each wildcard (* or ?) present in Mask, there must be a corresponding wildcard (of the same type) in ReparseMask; and the wildcards in ReparseMask must appear in the same order as they do in Mask. For example, if Mask is 20??_Budget.*, then 20??_Budget_Report.* would be a legal value for ReparseMask; but 20??_Budget_Report.xls would not be, nor would 20*_Budget_Report.*.

The Flags parameter specifies how, exactly, the redirection should be performed. Possible values are as follows:


FS_REPARSE_CHANGE_PATH	`0`	Perform redirection by modifying the path directly using the CBFilter system driver.
FS_REPARSE_USE_REPARSE_POINT	`1`	Perform redirection by having the CBFilter system driver emulate real reparse point behavior. This option will cause the driver to report that a file or directory's parent directory is a reparse point of the SYMLINK variety. Redirection performed in this manner is more consistent with Windows' behavior; however, some software may fail to correctly handle paths that cross such symbolic links.

add_virtual_file Method

This method adds a virtual file to the list of virtual entries and makes it visible in the filesystem.

Syntax

def add_virtual_file(file_name: str, creation_time: datetime.datetime, last_access_time: datetime.datetime, last_write_time: datetime.datetime, change_time: datetime.datetime, size: int, attributes: int) -> bool: ...

Remarks

This method creates or opens a virtual file and adds it to the list of virtual entries, managed by the class. If the class is active, the virtual file also appears in the filesystem. Virtual directories are not supported.

The class stores the creation parameters in the list. Adding the same file name several times will create only one list entry for each distinct file name, and subsequent calls to add_virtual_file with different parameters will be ignored. To update properties of the file that is already in the list, use the update_virtual_file method. To remove the file from the list, use the remove_virtual_file method.

The FileName parameter must contain the full path and name of the file being added. The drive on which the file resides may be referenced in one of following formats:

A volume GUID, formatted like Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} . A path may start with the \\?\ prefix, such as "\\?\Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}".
A DOS name, formatted like C:\.
A volume NT-native name, formatted like \Device\HarddiskVolumeX\, where X is the number of the volume.

To successfully add a virtual file, the volume in the path must already be present on the system.

Note: if an application adds multiple files to the same drive, it is more efficient to convert a GUID-based or a DOS-name-based volume name to the NT-native format using the get_nt_path_name method, then use the obtained NT-native volume name in the calls to this add_virtual_file method.

CreationTime, LastAccessTime, LastWriteTime, ChangeTime must specify the corresponding time values for the file, specified in UTC.

Size must be set to the size of the file. It may be 0 for an empty file or a positive value.

Attributes must be set to the file's attributes. Please refer to Microsoft's File Attribute Constants article for attribute descriptions.

The method will return True if the file was added to the list and False if the file is already present in the list. An error will be reported if adding the file failed on the driver side.

close_default_rules_snapshot Method

This method closes the previously created default rules snapshot.

Syntax

def close_default_rules_snapshot() -> None: ...

Remarks

This method closes the default rules snapshot previously created by create_default_rules_snapshot, releasing the memory associated with it. Please refer to that method's documentation for more information.

Note: This method cannot be called within events.

The methods and properties related to rule management are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads (e.g., during the on_after_filter_attach_to_volume and on_after_filter_detach_from_volume events) are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of the rule lists both occur in a thread-safe manner.

close_reparse_rules_snapshot Method

This method closes the previously created reparse rules snapshot.

Syntax

def close_reparse_rules_snapshot() -> None: ...

Remarks

This method closes the reparse rules snapshot previously created by create_reparse_rules_snapshot, releasing the memory associated with it. Please refer to that method's documentation for more information.

Note: This method cannot be called within events.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_default_rules_snapshot Method

This method creates a snapshot of information about the default rules that have been added.

Syntax

def create_default_rules_snapshot(product_guid: str) -> None: ...

Remarks

This method creates a snapshot of information about all default rules that have been added by the application identified by ProductGUID. This information is then used to populate the DefaultRule* properties.

When the application is finished working with the default rules snapshot, it must close it by calling the close_default_rules_snapshot method to release the associated memory. If this method is called again before an existing snapshot is closed, the class will attempt to close it before creating a new one.

Note: This method cannot be called within events.

create_file_direct Method

This method creates or opens a file or directory by passing the request directly to the filesystem.

Syntax

def create_file_direct(file_name: str, synchronize: bool, desired_access: int, share_mode: int, creation_disposition: int, flags_and_attributes: int, close_immediately: bool, send_via_stack: bool) -> int: ...

Remarks

This method should be used instead of the Windows API's CreateFile function to create or open a file or directory when an application needs to access this file without sending requests through the complete filesystem filter driver stack.

The parameters of this method correspond to the parameters of the CreateFile function.

If the file or directory is created or opened successfully, this method returns a file handle for it; otherwise, it returns INVALID_HANDLE_VALUE. The returned handle, if valid, must be closed using the Windows API's CloseHandle function when the application is finished with it. See the "Use of Handle" section below for details of how to use the handle.

If CloseImmediately is True, this method will create or open the specified file or directory and then immediately close the resulting handle. In this case, the handle will still be returned to indicate the success of the operation, but it will not be usable in any file operations.

The SendViaStack parameter specifies how the driver should send the request for opening the file as well as other requests that will be sent using the opened file handle. When this parameter is False, requests made by the application using the handle, created by the create_file_direct method, are sent directly to the filesystem. When some filter drivers are located lower in the driver stack than the CBFilter driver, such requests will bypass that filter drivers with possibly unexpected consequences (e.g., requests going to the wrong file, wrong data being read or written). Set this parameter to True to make the driver pass these requests down the filter stack, letting them reach other filter drivers before the filesystem.

When the SendViaStack parameter is False, requests against the returned file handle are routed directly to the filesystem (bypassing all filter drivers, including the class's); applications can use it to call the Windows File API functions (ReadFile, WriteFile) within filesystem-related events without causing a system deadlock. However, pay special attention to the Synchronize parameter's documentation, which is given below.

The FileName, DesiredAccess, CreationDisposition, and FlagsAndAttributes parameters correspond to the lpFileName, dwDesiredAccess, dwCreationDisposition, and dwFlagsAndAttributes parameters of the Windows API's CreateFile function (respectively).

Please refer to Microsoft's documentation for more information about how to set these parameters appropriately.

The CreationDisposition parameter should be set to one of the valid values and may not be 0. If any of these requirements is not met, the ERROR_INVALID_PARAMETER error is returned.

The ShareMode parameter should be set by ORing together zero or more of the following flags:


FILESYS_SHARE_NONE	`0x00000000`	Prevents any process from opening a file or device if it requests delete, read, or write access.
FILESYS_SHARE_READ	`0x00000001`	Enables subsequent open operations on a file or device to request read access. Enables subsequent open operations to request read access; otherwise, no process can open the file or device if it requests read access. If this flag is not specified, but the file or device has been opened for read access, the function fails.
FILESYS_SHARE_WRITE	`0x00000002`	Enables subsequent open operations on a file or device to request write access. Enables subsequent open operations to request write access; otherwise, no process can open the file or device if it requests write access. If this flag is not specified, but the file or device has been opened for write access or has a file mapping with write access, the function fails.
FILESYS_SHARE_DELETE	`0x00000004`	Enables subsequent open operations on a file or device to request delete access. Enables subsequent open operations to request delete access; otherwise, no process can open the file or device if it requests delete access. If this flag is not specified, but the file or device has been opened for delete access, the function fails. Note: Delete access allows both delete and rename operations.
CBFILTER_IGNORE_SHARE_ACCESS_CHECK	`0x10000000`	Specifies that the driver should pass IO_IGNORE_SHARE_ACCESS_CHECK flag to the system functions. Use this flag to bypass sharing checks performed by the I/O manager when opening local files. Note: The filesystem still may perform these checks. Also, the internal structures are not updated with the share mode values, passed in this call. This means that subsequent file open operations will not know about the previous share mode and may succeed where they would have to fail.

The Synchronize parameter specifies whether this method and operations with the resulting handle should be synchronized with the thread that originated the underlying filesystem request associated with the current event (i.e., the event that this method was called from).

The parameter is applicable only when a caller uses it to open the file, for which the event was fired, when isolation is not used. If the file create/open operation is isolated (the handler sets the Isolate parameter of the corresponding event to True), the application may safely set Synchronize to False. Also, the parameter should not be set to True when this method is called from the on_after_close_file event; when the event is fired, no file is open to synchronize operations with.

It is recommended to set Synchronize to True when the method is called from on_after_create_file and on_after_open_file event handlers. This helps prevent possible deadlocks in other filter drivers.

Please refer to Direct File operations for additional information about the use of a handle or a stream obtained using this method.

create_file_direct_as_stream Method

This method creates or opens a file by passing the request directly to the filesystem.

Syntax

def create_file_direct_as_stream(file_name: str, synchronize: bool, desired_access: int, share_mode: int, creation_disposition: int, flags_and_attributes: int, send_via_stack: bool, handle: List[int]) -> CBFSFilterStream: ...

Remarks

This method should be used instead of the Windows API's CreateFile function to create or open a file when an application needs to access this file without sending requests through the complete filesystem filter driver stack.

The parameters of this method correspond to the parameters of the CreateFile function.

If the file is created or opened successfully, this method returns a stream object that provides access to its data; otherwise, it returns None.

Upon success, the Handle parameter is populated with the file handle value. This handle value does not need to be closed - the class will do this automatically when the stream is closed. See the "Use of Handle" section below for details of how to use the handle.

When the SendViaStack parameter is False, requests against the opened file are routed directly to the filesystem (bypassing all filter drivers, including the class's); applications can use it within filesystem-related events without causing a system deadlock. However, pay special attention to the Synchronize parameter's documentation, which is given below.

Please refer to Microsoft's documentation for more information about how to set these parameters appropriately.

The CreationDisposition parameter should be set to one of the valid values and may not be 0. If any of these requirements is not met, the ERROR_INVALID_PARAMETER error is returned.

The ShareMode parameter should be set by ORing together zero or more of the following flags:


FILESYS_SHARE_NONE	`0x00000000`	Prevents any process from opening a file or device if it requests delete, read, or write access.
FILESYS_SHARE_READ	`0x00000001`	Enables subsequent open operations on a file or device to request read access. Enables subsequent open operations to request read access; otherwise, no process can open the file or device if it requests read access. If this flag is not specified, but the file or device has been opened for read access, the function fails.
FILESYS_SHARE_WRITE	`0x00000002`	Enables subsequent open operations on a file or device to request write access. Enables subsequent open operations to request write access; otherwise, no process can open the file or device if it requests write access. If this flag is not specified, but the file or device has been opened for write access or has a file mapping with write access, the function fails.
FILESYS_SHARE_DELETE	`0x00000004`	Enables subsequent open operations on a file or device to request delete access. Enables subsequent open operations to request delete access; otherwise, no process can open the file or device if it requests delete access. If this flag is not specified, but the file or device has been opened for delete access, the function fails. Note: Delete access allows both delete and rename operations.
CBFILTER_IGNORE_SHARE_ACCESS_CHECK	`0x10000000`	Specifies that the driver should pass IO_IGNORE_SHARE_ACCESS_CHECK flag to the system functions. Use this flag to bypass sharing checks performed by the I/O manager when opening local files. Note: The filesystem still may perform these checks. Also, the internal structures are not updated with the share mode values, passed in this call. This means that subsequent file open operations will not know about the previous share mode and may succeed where they would have to fail.

Please refer to Direct File operations for additional information about the use of a handle or a stream obtained using this method.

create_reparse_rules_snapshot Method

This method creates a snapshot of information about the reparse rules that have been added.

Syntax

def create_reparse_rules_snapshot(product_guid: str) -> None: ...

Remarks

This method creates a snapshot of information about all reparse rules that have been added by the application identified by ProductGUID. This information is then used to populate the ReparseRule* properties.

When the application is finished working with the reparse rules snapshot, it must close it by calling the close_reparse_rules_snapshot method to release the associated memory. If this method is called again before an existing snapshot is closed, the class will attempt to close it before creating a new one.

Note: This method cannot be called within events.

delete_all_filter_rules Method

This method deletes all standard filter rules and access rules.

Syntax

def delete_all_filter_rules() -> bool: ...

Remarks

This method deletes all standard filter rules and access rules that are currently present.

If the rules are deleted successfully, this method returns True; otherwise, it returns False.

To delete standard filter rules or access rules individually, use the delete_filter_rule method instead.

delete_all_passthrough_rules Method

This method deletes all passthrough rules.

Syntax

def delete_all_passthrough_rules() -> bool: ...

Remarks

This method deletes all passthrough rules that are currently present.

If the rules are deleted successfully, this method returns True; otherwise, it returns False.

To delete passthrough rules individually, use the delete_passthrough_rule method instead.

delete_all_reparse_rules Method

This method deletes all reparse rules.

Syntax

def delete_all_reparse_rules(product_guid: str) -> bool: ...

Remarks

This method deletes all reparse rules associated with the application identified by ProductGUID.

If the rules are deleted successfully, this method returns True; otherwise, it returns False.

In most cases, the value passed for the ProductGUID parameter should be the same one that was used to call the initialize method. Please refer to the add_reparse_rule method's documentation for more information.

To delete reparse rules individually, use the delete_reparse_rule method instead.

delete_default_rule Method

This method deletes a particular default rule.

Syntax

def delete_default_rule(mask: str, access_flags: int, product_guid: str) -> bool: ...

Remarks

This method deletes the specified AccessFlags from the default rule identified by Mask and associated with the application identified by ProductGUID. If AccessFlags includes all flags currently present in the rule, then the entire rule is deleted; otherwise, the flags specified by AccessFlags are simply removed from the rule.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the file mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.

The AccessFlags parameter specifies which access restrictions should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

In most cases, the value passed for the ProductGUID parameter should be the same one that was used to call the initialize method. Please refer to the add_default_rule method's documentation for more information.

delete_filter_rule Method

This method deletes a particular standard filter rule or access rule.

Syntax

def delete_filter_rule(mask: str, access_flags: int, control_flags: int, notify_flags: int) -> bool: ...

Remarks

This method deletes the specified AccessFlags, ControlFlags, and/or NotifyFlags from the standard filter rule and/or access rule identified by Mask. If the aforementioned parameters include all flags currently present in the rule, then the entire rule is deleted; otherwise, the specified flags are simply removed from the rule.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the file mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.

The ControlFlags parameter specifies which Control Event flags should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.

The NotifyFlags parameter specifies which Notification Event flags should be removed from the rule. The value passed for this parameter should be constructed by ORing together zero or more of the following flags:


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

To delete all standard filter rules and access rules, use the delete_all_filter_rules method instead.

delete_passthrough_rule Method

This method deletes a particular passthrough rule.

Syntax

def delete_passthrough_rule(mask: str, access_flags: int, control_flags: int, notify_flags: int) -> bool: ...

Remarks

This method deletes the specified AccessFlags, ControlFlags, and/or NotifyFlags from the passthrough rule identified by Mask. If the aforementioned parameters include all flags currently present in the rule, then the entire rule is deleted; otherwise, the specified flags are simply removed from the rule.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the file mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.


ACCESS_NONE	`0x00`	No access restrictions.
ACCESS_READ_ONLY	`0x01`	Read-only access; writing and deleting are prohibited.
ACCESS_WRITE_ONLY	`0x02`	Write-only access; reading and deleting are prohibited.
ACCESS_DELETE_PROTECT	`0x04`	Deleting and renaming are prohibited.
ACCESS_EXECUTE_PROTECT	`0x08`	Execution is prohibited.
ACCESS_NO_CHANGE_DAC	`0x10`	Change of security attributes is prohibited.
ACCESS_NO_CHANGE_OWNER	`0x20`	Change of owner is prohibited.
ACCESS_RENAME_PROTECT	`0x40`	Renaming is prohibited.
ACCESS_DELETE_ONLY_PROTECT	`0x80`	Deleting is prohibited (renaming is not affected).
ACCESS_REMOTE_ACCESS_PROTECT	`0x100`	Access from other systems is prohibited.
ACCESS_DENY_ALL	`0x200`	All access is denied.
ACCESS_ALL_FLAGS	`-1`	Used to denote all currently set access restriction flags.


FS_CE_NONE	`0`	Don't fire for any filesystem operations. Control Events will not fire for any filesystem operations.
FS_CE_BEFORE_CREATE	`0x000000000001L`	Fire before file creation operations. The on_before_create_file event will fire anytime the OS attempts to create a file or directory. In some cases, this event can cause the on_before_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_CREATE	`0x000000000002L`	Fire after file creation operations. The on_after_create_file event will fire after a file or directory creation request has been processed, before the response is returned. In some cases, this event can cause the on_after_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_OPEN	`0x000000000004L`	Fire before file open operations. The on_before_open_file event will fire anytime the OS attempts to open a file or directory. In some cases, this event can cause the on_before_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_AFTER_OPEN	`0x000000000008L`	Fire after file open operations. The on_after_open_file event will fire after a file or directory open request has been processed, before the response is returned. In some cases, this event can cause the on_after_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_CE_BEFORE_READ	`0x000000000010L`	Fire before read operations. The on_before_read_file event will fire anytime the OS attempts to read data from a file.
FS_CE_AFTER_READ	`0x000000000020L`	Fire after read operations. The on_after_read_file event will fire after a read request has been processed, before the response is returned.
FS_CE_BEFORE_WRITE	`0x000000000040L`	Fire before write operations. The on_before_write_file event will fire anytime the OS attempts to write data to a file.
FS_CE_AFTER_WRITE	`0x000000000080L`	Fire after write operations. The on_after_read_file event will fire after a write request has been processed, before the response is returned.
FS_CE_BEFORE_LOCK_CONTROL	`0x000000000100L`	Fire before lock and unlock operations. The on_before_lock, on_before_unlock_all, on_before_unlock_all_by_key, and on_before_unlock_single events will fire, as applicable, before the OS attempts to lock or unlock a range of bytes in a file.
FS_CE_AFTER_LOCK_CONTROL	`0x000000000200L`	Fire before and after lock and unlock operations. The on_after_lock, on_after_unlock_all, on_after_unlock_all_by_key, and on_after_unlock_single, events will fire, as applicable, after a lock or unlock request has been processed, before the response is returned.
FS_CE_BEFORE_CLEANUP	`0x000000000400L`	Fire before file handle cleanup operations. The on_before_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_CE_AFTER_CLEANUP	`0x000000000800L`	Fire after file handle cleanup operations. The on_after_cleanup_file event will fire after a file handle cleanup request has been processed, before the response is returned.
FS_CE_BEFORE_CLOSE	`0x000000001000L`	Fire before file close operations. The on_before_close_file event will fire anytime the OS closes a file or directory. Also, the on_after_close_enumeration event will fire anytime the OS closes a directory enumeration (which typically occurs immediately before the directory is closed).
FS_CE_AFTER_CLOSE	`0x000000002000L`	Fire after file close operations. The on_after_close_file event will fire after a file/directory close request has been processed, before the response is returned.
FS_CE_BEFORE_CAN_DELETE	`0x000000004000L`	Fire before 'can be deleted' operations. The on_before_can_file_be_deleted event will fire anytime the OS checks whether a file or directory can be deleted.
FS_CE_AFTER_CAN_DELETE	`0x000000008000L`	Fire after 'can be deleted' operations. The on_after_can_file_be_deleted event will fire after a `can be deleted` request has been processed, before the response is returned.
FS_CE_BEFORE_DELETE	`0x000000010000L`	Fire before delete operations The on_before_delete_file event will fire anytime the OS attempts to delete a file or directory.
FS_CE_AFTER_DELETE	`0x000000020000L`	Fire after delete operations. The on_after_delete_file event will fire after a delete request has been processed, before the response is returned.
FS_CE_BEFORE_RENAME	`0x000000040000L`	Fire before rename/move operations. The on_before_rename_or_move_file event will fire anytime the OS attempts to rename or move a file or directory.
FS_CE_AFTER_RENAME	`0x000000080000L`	Fire after rename/move operations. The on_after_rename_or_move_file event will fire after a rename or move request has been processed, before the response is returned.
FS_CE_BEFORE_GET_SECURITY	`0x000000100000L`	Fire before get security operations. The on_before_get_file_security event will fire before the OS queries the security attributes of a file or directory.
FS_CE_AFTER_GET_SECURITY	`0x000000200000L`	Fire after get security operations. The on_after_get_file_security events will fire after a `get security operation` has been processed, before the response is returned.
FS_CE_BEFORE_ENUMERATE_DIRECTORY	`0x000000400000L`	Fire before directory enumeration operations. The on_before_enumerate_directory event will fire anytime the OS needs to read information about directory entries.
FS_CE_AFTER_ENUMERATE_DIRECTORY	`0x000000800000L`	Fire after directory enumeration operations. The on_after_enumerate_directory event will fire after information about a directory entry has been retrieved during directory enumeration, before the response is returned.
FS_CE_BEFORE_QUERY_FILE_INFO	`0x000001000000L`	Fire before 'query file information' operations. The on_before_query_file_info event will fire anytime the OS needs to retrieve information about a file or directory.
FS_CE_AFTER_QUERY_FILE_INFO	`0x000002000000L`	Fire after 'query file information' operations. The on_after_query_file_info event will fire after a file or directory information query request has been processed, before the response is returned.
FS_CE_AFTER_GET_SIZES	`0x000008000000L`	Fire after get size operations. The on_after_get_file_sizes event will fire after a file's size information is retrieved, before the response is returned.
FS_CE_BEFORE_SET_SECURITY	`0x000010000000L`	Fire before set security operations. The on_before_set_file_security event will fire anytime the OS needs to change the security attributes of a file or directory.
FS_CE_AFTER_SET_SECURITY	`0x000020000000L`	Fire after set security operations. The on_after_set_file_security event will fire after a security attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_ATTRIBUTES	`0x000040000000L`	Fire before file attribute update operations. The on_before_set_file_attributes event will fire anytime the OS attempts to change the attributes of a file or directory.
FS_CE_AFTER_SET_ATTRIBUTES	`0x000080000000L`	Fire after file attribute update operations. The on_after_set_file_attributes event will fire after a file attribute change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_SIZES	`0x000100000000L`	Fire before file resize operations. The on_before_set_file_size event will fire anytime the OS attempts to resize a file, and the on_before_set_allocation_size event will fire anytime the OS attempts to change a file's allocation size.
FS_CE_AFTER_SET_SIZES	`0x000200000000L`	Fire after file resize operations. The on_after_set_file_size event will fire after a file resize request has been processed, and the on_after_set_allocation_size event will fire after a file allocation size change request has been processed, before the response is returned.
FS_CE_BEFORE_CREATE_HARD_LINK	`0x000400000000L`	Fire before hard link creation operations. The on_before_create_hard_link event will fire anytime the OS attempts to create a hard link.
FS_CE_AFTER_CREATE_HARD_LINK	`0x000800000000L`	Fire after hard link creation operations. The on_after_create_hard_link events will fire after a hard link creation request has been processed, before the response is returned.
FS_CE_BEFORE_FSCTL	`0x001000000000L`	Fire before FSCTL operations. The on_before_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` request occurs.
FS_CE_AFTER_FSCTL	`0x002000000000L`	Fire after FSCTL operations. The on_after_fsctl event will fire after an `IRP_MJ_FILE_SYSTEM_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_IOCTL	`0x004000000000L`	Fire before IOCTL operations. The on_before_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` request occurs.
FS_CE_AFTER_IOCTL	`0x008000000000L`	Fire after IOCTL operations. The on_after_ioctl event will fire after an `IRP_MJ_DEVICE_CONTROL` request has been processed, before the response is returned.
FS_CE_BEFORE_SET_FILE_INFO	`0x010000000000L`	Fire before 'set file information' operations. The on_before_set_file_info event will fire anytime the OS needs to change information about a file or directory.
FS_CE_AFTER_SET_FILE_INFO	`0x020000000000L`	Fire after 'set file information' operations. The on_after_set_file_info event will fire after a file or directory information change request has been processed, before the response is returned.
FS_CE_BEFORE_SET_EA	`0x040000000000L`	Fire before Set Extended Attributes operations. The on_before_set_ea event will fire anytime the OS needs to set extended attributes of a file.
FS_CE_AFTER_SET_EA	`0x080000000000L`	Fire after Set Extended Attributes operations. The on_after_set_ea event will fire after the OS request to set extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_QUERY_EA	`0x100000000000L`	Fire before Query Extended Attributes operations. The on_before_query_ea event will fire anytime the OS needs to retrieve extended attributes of a file.
FS_CE_AFTER_QUERY_EA	`0x200000000000L`	Fire after Query Extended Attributes operations. The on_after_query_ea event will fire after the OS request to retrieve extended attributes of a file has been processed, before the response is returned.
FS_CE_BEFORE_GET_REPARSE_POINT	`0x400000000000L`	Fire before Get Reparse Point operations. The on_before_get_reparse_point event will fire anytime the OS needs to read a reparse point of a file or directory.
FS_CE_AFTER_GET_REPARSE_POINT	`0x800000000000L`	Fire after Get Reparse Point operations. The on_after_get_reparse_point event will fire after the OS request to read a reparse point of a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_SET_REPARSE_POINT	`0x1000000000000L`	Fire before Set Reparse Point operations. The on_before_set_reparse_point event will fire anytime the OS needs to set or update a reparse point for a file or directory.
FS_CE_AFTER_SET_REPARSE_POINT	`0x2000000000000L`	Fire after Set Reparse Point operations. The on_after_set_reparse_point event will fire after the OS request to set or update a reparse point for a file or directory has been processed, before the response is returned.
FS_CE_BEFORE_DELETE_REPARSE_POINT	`0x4000000000000L`	Fire before Delete Reparse Point operations. The on_before_delete_reparse_point event will fire anytime the OS needs to remove reparse point information from a file or directory.
FS_CE_AFTER_DELETE_REPARSE_POINT	`0x8000000000000L`	Fire after Delete Reparse Point operations. The on_after_delete_reparse_point event will fire after the OS request to remove reparse point information from a file or directory has been processed, before the response is returned.
FS_CE_REPARSE_FILENAME	`0x40000000000000L`	Fire before various operations for the purpose of file redirection. The on_reparse_file_name event will fire before any operation that includes a file or directory name, giving the application a chance to redirect it. This event is typically used when an application requires more advanced redirection logic than Reparse Rules can provide; please refer to that topic for more information.
FS_CE_REPARSE_TAG	`0x80000000000000L`	Fire for reparse operations. The on_reparse_with_tag event will fire anytime a file/directory open operation returns a `STATUS_REPARSE` result, allowing the application to handle the reparse point. Please refer to Microsoft's Reparse Points article for more information.
FS_CE_ALL	`-1`	Fire for all filesystem operations. Control Events will fire for all filesystem operations that the class tracks.


FS_NE_NONE	`0`	Don't fire for any filesystem operations. Notification Events will not fire for any filesystem operations.
FS_NE_CREATE	`0x00000001L`	Fire for file creation operations. The on_notify_create_file event will fire anytime the OS creates a file or directory. In some cases, this event can cause the on_notify_open_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_OPEN	`0x00000002L`	Fire for file open operations. The on_notify_open_file event will fire anytime the OS opens a file or directory. In some cases, this event can cause the on_notify_create_file event to fire; refer to the File Create/Open Events topic for more information.
FS_NE_READ	`0x00000004L`	Fire for read operations. The on_notify_read_file event will fire anytime the OS reads data from a file.
FS_NE_WRITE	`0x00000008L`	Fire for write operations. The on_notify_write_file event will fire anytime the OS writes data to a file.
FS_NE_LOCK_CONTROL	`0x00000010L`	Fire for lock and unlock operations. The on_notify_lock, on_notify_unlock_all, on_notify_unlock_all_by_key, and on_notify_unlock_single events will fire, as applicable, anytime the OS locks or unlocks a range of bytes in a file.
FS_NE_CLEANUP	`0x00000020L`	Fire for file handle cleanup operations. The on_notify_cleanup_file event will fire anytime a process closes a file or directory handle.
FS_NE_CLOSE	`0x00000040L`	Fire for file close operations. The on_notify_close_file event will fire anytime the OS closes a file or directory.
FS_NE_CAN_DELETE	`0x00000080L`	Fire for 'can be deleted' operations. The on_notify_can_file_be_deleted event will fire anytime the OS checks whether or not a file or directory can be deleted.
FS_NE_DELETE	`0x00000100L`	Fire for delete operations. The on_notify_delete_file event will fire anytime the OS deletes a file or directory.
FS_NE_RENAME	`0x00000200L`	Fire for rename/move operations. The on_notify_rename_or_move_file event will fire anytime the OS renames or moves a file or directory.
FS_NE_GET_SECURITY	`0x00000400L`	Fire for get security operations. The on_notify_get_file_security event will fire anytime the OS queries the security attributes of a file or directory.
FS_NE_ENUMERATE_DIRECTORY	`0x00000800L`	Fire for directory enumeration operations. The on_notify_enumerate_directory event will fire anytime the OS retrieves a directory entry during directory enumeration.
FS_NE_QUERY_FILE_INFO	`0x00001000L`	Fire for QueryFileInformation operations. The on_notify_query_file_info event will fire anytime the OS retrieves information about a file or directory.
FS_NE_GET_SIZES	`0x00002000L`	Fire for get size operations. The on_notify_get_file_sizes event will fire anytime the OS retrieves a file's size information.
FS_NE_SET_SECURITY	`0x00004000L`	Fire for set security operations. The on_notify_set_file_security event will fire anytime the OS changes the security attributes of a file or directory.
FS_NE_SET_ATTRIBUTES	`0x00008000L`	Fire for file attribute update operations. The on_notify_set_file_attributes event will fire anytime the OS changes the attributes of a file or directory.
FS_NE_SET_SIZES	`0x00010000L`	Fire for file resize operations. The on_notify_set_file_size event will fire anytime the OS resizes a file, and the on_notify_set_allocation_size event will fire anytime the OS changes a file's allocation size.
FS_NE_CREATE_HARD_LINK	`0x00020000L`	Fire for hard link creation operations. The on_notify_create_hard_link event will fire anytime the OS creates a hard link.
FS_NE_FSCTL	`0x00040000L`	Fire for FSCTL operations. The on_notify_fsctl event will fire anytime an `IRP_MJ_FILE_SYSTEM_CONTROL` operation occurs.
FS_NE_IOCTL	`0x00080000L`	Fire for IOCTL operations. The on_notify_ioctl event will fire anytime an `IRP_MJ_DEVICE_CONTROL` operation occurs.
FS_NE_SET_FILE_INFO	`0x00100000L`	Fire for SetFileInformation operations. The on_notify_set_file_info event will fire anytime the OS changes information about a file or directory.
FS_NE_SET_EA	`0x00200000L`	Fire for Set Extended Attributes operations. The on_notify_set_ea event will fire anytime the OS sets extended attributes of a file.
FS_NE_QUERY_EA	`0x00400000L`	Fire for Query Extended Attributes operations. The on_notify_query_ea event will fire anytime the OS retrieves extended attributes of a file.
FS_NE_GET_REPARSE_POINT	`0x00800000L`	Fire for Get Reparse Point operations. The on_notify_get_reparse_point event will fire anytime the OS reads reparse point information of a file or directory.
FS_NE_SET_REPARSE_POINT	`0x01000000L`	Fire for Set Reparse Point operations. The on_notify_set_reparse_point event will fire anytime the OS sets or updates reparse point information for a file or directory.
FS_NE_DELETE_REPARSE_POINT	`0x02000000L`	Fire for Delete Reparse Point operations. The on_notify_delete_reparse_point event will fire anytime the OS deletes reparse point information from a file or directory.
FS_BYPASS_IO	`0x40000000L`	Fire for BypassIO operations. The on_bypass_io_request event will fire anytime the OS sends a BypassIO request related to some file. This flag should be passed with notification flags, even though the event is synchronous.
FS_NE_ALL	`-1`	Fire for all filesystem operations. Notification Events will fire for all filesystem operations that the class tracks.

To delete all passthrough rules, use the delete_all_passthrough_rules method instead.

delete_reparse_rule Method

This method deletes a particular reparse rule.

Syntax

def delete_reparse_rule(mask: str, product_guid: str) -> bool: ...

Remarks

This method deletes the ReparseRules identified by Mask and associated with the application identified by ProductGUID.

If the flags or this rule are deleted successfully, this method returns True; otherwise, it returns False.

The Mask parameter must be the file mask of an existing rule. If a rule with the specified mask cannot be found, this method will fail.

To delete all reparse rules, use the delete_all_reparse_rules method instead.

file_matches_mask Method

This method checks whether a particular file or directory name matches the specified mask.

Syntax

def file_matches_mask(mask: str, file_name: str, case_sensitive: bool) -> bool: ...

Remarks

This method checks whether the file or directory name specified by FileName matches Mask; if it does, this method returns True. The CaseSensitive parameter controls whether a case-sensitive match should be performed.

Note: This method does not handle so-called DOS_* wildcards (DOS_STAR, DOS_QM, DOS_DOT). The explanation about the characters can be found in the MSDN article. If you have a mask that includes one of those characters on Windows, you can use the RtlIsNameInExpression function of Windows API.

Note: As the explanation states, "When you do a case-insensitive search and do not provide a translation table, the name is converted to uppercase."

get_driver_status Method

This method retrieves the status of the class's system driver.

Syntax

def get_driver_status(product_guid: str) -> int: ...

Remarks

This method retrieves the status of the class's system driver. This status can then be used to verify whether it has been properly installed and is ready for use.

The value returned by the method corresponds to the dwCurrentState field of the SERVICE_STATUS structure from the Windows API. It will be one of the following:


MODULE_STATUS_NOT_PRESENT	`0x00000000`	The specified module is not present on the system. Note: This functionality is only available in Windows.
MODULE_STATUS_STOPPED	`0x00000001`	The specified module is in the Stopped state. Note: This functionality is only available in Windows.
MODULE_STATUS_RUNNING	`0x00000004`	The specified module is loaded and running. Note: This functionality is only available in Windows.

ProductGUID is used to distinguish among driver installations performed by different applications. Such information is necessary to guard against unexpected situations, such as the driver being uninstalled by one application despite other applications still needing it.

Therefore, to ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

install
uninstall
get_driver_status
get_driver_version
initialize

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

get_driver_version Method

This method retrieves the version of the class's system driver.

Syntax

def get_driver_version(product_guid: str) -> int: ...

Remarks

This method retrieves the version of the class's system driver. The value is returned as a 64-bit integer composed of four 16-bit words that each correspond to a piece of the overall module version. For example, a version of 2.32.6.28 would cause the value 0x000200200006001C to be returned.

If the class's system driver is not installed, this method returns 0.

install
uninstall
get_driver_status
get_driver_version
initialize

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

get_event_file_name Method

This method retrieves the name of the file or directory, to which the event applies.

Syntax

def get_event_file_name() -> str: ...

Remarks

This method can be called within event handlers of events, related to the file or directory operations, to retrieve the name of the file or directory, to which the operation applies. If the query fails or an event does not have an associated file name, this method returns an empty string.

get_handle_creator_process_id Method

This method retrieves the Id of the process (PID) that opened the file handle.

Syntax

def get_handle_creator_process_id() -> int: ...

Remarks

This method can be called within certain events to retrieve the Id of the process (PID) that opened the file handle. If the query fails, this method returns 0.

Note: PIDs are not unique and may be reused by different processes over time (although in practice, this is uncommon).

Applications cannot use this method to retrieve information about remote processes accessing drives shared on the network. Windows does not provide such information due to the nature of remote access.

Note: This method can be called only within the on_after_create_file and on_after_open_file events, and must be called in the same thread that the event was originally fired on. Applications that need the information that this method returns during other events can do the following:

Call this method within the on_after_create_file or on_after_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information through the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: This method cannot be used from on_cleanup_context event handlers.

get_handle_creator_process_name Method

This method retrieves the name of the process that opened the file handle.

Syntax

def get_handle_creator_process_name() -> str: ...

Remarks

This method can be called within certain events to retrieve the name of the process that opened the file handle. If the query fails, this method returns an empty string.

Call this method within the on_after_create_file or on_after_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information through the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: This method cannot be used from on_cleanup_context event handlers.

get_handle_creator_thread_id Method

This method retrieves the Id of the thread that opened the file handle.

Syntax

def get_handle_creator_thread_id() -> int: ...

Remarks

This method can be called within certain events to retrieve the Id of the thread that opened the file handle. If the query fails, this method returns 0.

Notes: Thread Ids are not unique and may be reused by different threads over time.

Call this method within the on_after_create_file or on_after_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information through the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: This method cannot be used from on_cleanup_context event handlers.

get_handle_creator_token Method

This method retrieves the security token associated with the process that opened the file handle.

Syntax

def get_handle_creator_token() -> int: ...

Remarks

This method can be called within certain events to retrieve the security token associated with the process that opened the file handle. If the query fails, this method returns INVALID_HANDLE_VALUE.

The security token returned by this method can be passed to the Windows API's GetTokenInformation function to obtain more information about the process.

Note: When applications are finished using the returned security token, they must close it using the Windows API's CloseHandle function.

Network Access Notes

Applications monitoring a drive shared on the network may wish to obtain information about the network users accessing it (e.g., account names). Drives can be shared in several modes in Windows, which can affect the information retrievable via the security token this method returns:

Authenticated mode, in which case the network redirector (which, in general, is responsible for relaying remote drive requests to and from the system driver) will impersonate the network user, allowing that account's actual information to be retrieved.
Guest mode, in which case the retrievable information is for the system's GUEST account.
Administrative shares (those which exist by default and whose names end with '$'; e.g., C$, ADMIN$, etc.), in which case the retrievable information is for the LOCAL_SYSTEM account.

Call this method within the on_after_create_file or on_after_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information through the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: This method cannot be used from on_cleanup_context event handlers.

get_operation_time Method

This method returns the time at which the request was received by the filter driver.

Syntax

def get_operation_time() -> datetime.datetime: ...

Remarks

This method can be called within operation-related events to retrieve the time at which the filter driver received the request. The time is recorded before an event is fired but only when the RecordOperationTime configuration setting is enabled.

The timestamps returned by this method are specified in UTC.

get_originator_process_id Method

Retrieves the Id of the process (PID) that initiated the operation.

Syntax

def get_originator_process_id() -> int: ...

Remarks

This method can be called within events fired for filesystem operations to retrieve the Id of the process (PID) that initiated the operation. If the query fails, this method returns 0.

Please note that PIDs are not unique, and may be reused by different processes over time (though in practice, this is uncommon).

Note: This method can be called only within events, and it must be called in the same thread that the event was originally fired on. However, it must not be called within events that work with opened files since such events can be initiated by system components (e.g., the cache manager, memory manager, etc.). If applications need the information this method returns during such events, they may do the following:

Call this method within the on_create_file or on_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

Note: This method cannot be used from on_cleanup_context event handlers.

get_originator_process_name Method

Retrieves the name of the process that initiated the operation.

Syntax

def get_originator_process_name() -> str: ...

Remarks

This method can be called within events fired for filesystem operations to retrieve the name of the process that initiated the operation. If the query fails, this method returns empty string.

Call this method within the on_create_file or on_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

Note: This method cannot be used from on_cleanup_context event handlers.

get_originator_thread_id Method

Retrieves the Id of the thread that initiated the operation.

Syntax

def get_originator_thread_id() -> int: ...

Remarks

This method can be called within events fired for filesystem operations to retrieve the Id of the thread that initiated the operation. If the query fails, this method returns 0.

Please note that thread Ids are not unique, and may be reused by different threads over time.

Call this method within the on_create_file or on_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

Note: This method cannot be used from on_cleanup_context event handlers.

get_originator_token Method

Retrieves the security token associated with the process that initiated the operation.

Syntax

def get_originator_token() -> int: ...

Remarks

This method can be called within synchronous, i.e., Before* and After* events fired for filesystem operations to retrieve the security token associated with the process that initiated the operation. If the query fails, this method returns INVALID_HANDLE_VALUE. Note: This method will not work properly when called from Notify* event handlers because security tokens are not kept for possible later use. If you need to obtain security information about a request, use corresponding After* events.

The security token returned by this method can be passed to the Windows API's GetTokenInformation function to obtain more information about the process.

Important: When applications are finished using the returned security token, they must close it using the Windows API's CloseHandle function.

Network Access Notes

Authenticated mode, in which case the network redirector (which, in general, is responsible for relaying remote drive requests to and from the system driver) will impersonate the network user, allowing that account's actual information to be retrieved.
Guest mode, in which case the retrievable information is for the system's GUEST account.
Administrative shares (those which exist by default and whose names end with '$'; e.g., C$, ADMIN$, etc.), in which case the retrievable information is for the LOCAL_SYSTEM account.

Call this method within the on_create_file or on_open_file event.
Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
In a later event, access the information via the reference stored in HandleContext.

Please refer to the Contexts topic for more information on how to use events' context parameters.

Note: Renaming and deletion of files is performed after the file is opened. Thus, access checks should be performed during file opening as described above.

Note: This method cannot be used from on_cleanup_context event handlers.

get_remote_access_information Method

This method returns networking-related information about the operation.

Syntax

def get_remote_access_information(share_name: List[str], client_socket_address_buffer: int, client_socket_address_buffer_size: List[int]) -> None: ...

Remarks

Call this method from *CreateFile/*OpenFile events to retrieve the collected networking details information related to the filesystem operation performed across the network.

Note: The information will be available only when the CollectRemoteOpenInformation configuration setting is enabled.

This method returns the contents of one of two structures, SRV_OPEN_ECP_CONTEXT or NFS_OPEN_ECP_CONTEXT. These structures contain various networking information that differs depending on the remote access type. Please refer to MSDN for additional information.

Depending on the type of remote access, the information is extracted from one of those structures. When the method returns, ShareName will contain the value of either ShareName or ExportAlias field of the corresponding structure. ClientSocketAddressBuffer will contain the value of the SocketAddress or ClientSocketAddress field of the corresponding structure. This field is a structure of the SOCKADDR_STORAGE_NFS type.

When calling the method, an application needs to prepare the buffer of the required size and specify this size of the ClientSocketAddressBuffer buffer in the ClientSocketAddressBufferSize argument.

get_reparse_rule_by_mask Method

This method retrieves the reparse rule associated with the specified file mask.

Syntax

def get_reparse_rule_by_mask(mask: str, product_guid: str) -> str: ...

Remarks

This method retrieves the reparse rule identified by Mask and associated with the application identified by ProductGUID. If such a reparse rule is found, this method returns its reparse mask (see add_reparse_rule); otherwise, it returns empty string.

The Mask parameter must be the file mask of an existing rule.

In most cases, the value passed for the ProductGUID parameter should be the same one that was used to call the initialize method.

get_volume_guid Method

This method retrieves the volume GUID of the device targeted by a filesystem operation.

Syntax

def get_volume_guid() -> str: ...

Remarks

This method can be called within events fired for filesystem operations to retrieve the volume GUID of the device targeted by the operation, returned in the Volume{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx} format. If the query fails, this method returns an empty string.

Volume GUIDs can be used to enumerate the mounting points of a device using the Windows API's GetVolumePathNamesForVolumeName function.

Note: This method can be called only within events.

initialize Method

This method initializes the class.

Syntax

def initialize(product_guid: str) -> None: ...

Remarks

This method initializes the class and must be called each time the application starts before attempting to call any of the class's other methods with the exception of installation-related methods.

install
uninstall
get_driver_status
get_driver_version
initialize

If the required driver was not installed using the install method with the same value of ProductGUID, initialize will return a ERROR_FILE_NOT_FOUND error (Win32 error code 2).

If the loaded kernel-mode driver is older than the user-mode API, initialize will return a ERROR_INVALID_KERNEL_INFO_VERSION error (Win32 error code 340). In this situation, an update of the driver using the install method is required before the class can be used.

install Method

This method installs (or upgrades) the class's system driver.

Syntax

def install(cab_file_name: str, product_guid: str, path_to_install: str, altitude: str, flags: int, allowed_controllers: str) -> bool: ...

Remarks

This method is used to install or upgrade the class's system driver. If the system must be rebooted to complete the installation process, this method returns True; otherwise, it returns False.

Important: To upgrade the class's driver, use only the install method. Previously installed versions of the driver should not be uninstalled first. Calling the install method will upgrade the previously installed version.

Please refer to the Driver Installation topic for more information.

CabFileName must be the path of the cbfilter.cab file containing the class's system driver.

Note: This .cab file must remain on the target system (or be available in some other way) after installation, as it is required to uninstall the driver from the system.

install
uninstall
get_driver_status
get_driver_version
initialize

PathToInstall controls where the driver is installed. Pass empty string (highly recommended) to automatically install them to the appropriate Windows system directory.

Altitude specifies the driver altitude to use . During development, you can use any acceptable altitude value. For deployment, an altitude value must be assigned by Microsoft before deploying a filesystem minifilter in production. After installation, the altitude can be changed at any time using the altitude property. Please refer to the Driver Altitudes topic for more information.

Flags specifies various installation options. It should contain zero or more of the following flags, ORed together:


INSTALL_REMOVE_OLD_VERSIONS	`0x00000001`	Uninstall drivers from previous class versions (e.g., 2017).
INSTALL_KEEP_START_TYPE	`0x00000002`	Keep the driver's current start type setting in the registry. If this flag is not set (default), the installation logic will reset the driver's start type setting in the Windows registry to the default value. Setting this flag causes the installation logic to preserve the current value, which may be necessary if the user (or the application) set it previously.
INSTALL_OVERWRITE_SAME_VERSION	`0x00000004`	Install the driver file when its version and build number is the same as the version of the already installed driver.
INSTALL_REQUESTS_VIA_DRIVER_STACK	`0x00001000`	Whether internal requests to the filesystem are sent directly to the filesystem driver or through the stack of filesystem filter drivers. This flag is applicable only for CBFilter and CBMonitor. After installation, the effects of this flag can be changed using the SendRequestsViaDriverStack configuration setting.
INSTALL_ALWAYS_PREPARE_FILES	`0x00010000`	Whether the driver should keep track of information for files that are already open when (i.e., were opened before) the class is initialized. This flag is applicable only for CBFilter and CBMonitor. If this flag is set, the driver will prepare information about each file as it is opened, regardless of whether a CBFilter/CBMonitor-based application is actually running at the time. This information then allows applications to receive events for any files that are already open when the CBFilter/CBMonitor class is initialized. Note: These preparations will slow down all file open operations; do not enable this feature unless it is actually necessary. After installation, the effects of this flag can be changed using the AlwaysPrepareFiles configuration setting.
INSTALL_FORCE_APP_PERMISSION_CHECK	`0x00020000`	Whether the driver should require the controller process to have elevated or system privileges. This flag is not applicable for CBProcess. If this flag is set, the driver will verify that the controller process is a system service (or is executing with elevated privileges) anytime a file is opened. If the controller process does not meet these requirements, the file will be skipped (i.e., not filtered in any way). Note: This additional verification will slow down all file open operations. After installation, the effects of this flag can be changed using the ForceAppPermissionCheck configuration setting.
INSTALL_FORCE_SECURITY_CHECKS	`0x00040000`	Whether the driver should prevent the controller process from filtering files that it would not normally have access to. This flag is not applicable for CBProcess. If this flag is set, the driver will check the security permissions of the controller process anytime a file is opened to verify that the process has access to the file. If the controller process does not have access to the file, the file will be skipped (i.e., not filtered in any way). For example, if this flag is set and the controller process is running with limited privileges, then the driver will not allow it to filter files that require greater privileges to access. Note: This additional verification will slow down all file open operations. After installation, the effects of this flag can be changed using the ForceSecurityChecks configuration setting.

Note: Enabling the AlwaysPrepareFiles and/or SendRequestsViaDriverStack configuration settings before calling this method will cause the corresponding flags to be added automatically. These configuration settings can also be used to toggle the corresponding options at any time after installation.

AllowedControllers is the optional parameter that makes it possible to limit communication with the driver to just the predefined set of processes. When the caller specifies one or more names of the executable files, filtering can be started with the specified ProductGUID only when filtering is initiated by the process created from one of the listed executable files. If the name of the caller process does not match any of the allowed names, the call to start_filter will fail with an error.

The parameter may be either empty or contain one or more EXE file names with complete paths. Separate names/paths should be separated by the LF character (numeric code 10).

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

is_file_filtered Method

This method checks whether a particular file or directory is covered by any filter rules.

Syntax

def is_file_filtered(file_name: str) -> bool: ...

Remarks

This method checks whether the file or directory specified by FileName is covered by any of the standard filter rules active currently (i.e., whether the class would fire its events for one or more kinds of filesystem operations performed on it). If the specified file or directory matches any of the active standard filter rules, this method returns True; otherwise, it returns False.

Applications should use this method anytime they want to create/open some file or directory from within an event handler. If this method returns True, then the file or directory must be created/opened using the class's create_file_direct method rather than the Windows API's CreateFile function, because the latter could trigger recursion and cause a system deadlock.

nt_status_to_win32_error Method

This method converts a native status code to a Win32 error code.

Syntax

def nt_status_to_win32_error(status: int) -> int: ...

Remarks

This method converts the native status code specified by Status to a Win32 error code. If the specified native status code does not map directly to a Win32 error code, this method returns ERROR_MR_MID_NOT_FOUND (317).

query_file_information_direct Method

This method returns various kinds of information about a file object.

Syntax

def query_file_information_direct(file_handle: int, file_information: bytes, file_information_class: int, bytes_transferred: List[int]) -> None: ...

Remarks

Applications may call this method to query various kinds of information about the file or directory using the open handle. The method uses the NtQueryInformationFile Windows API function to retrieve the information.

The FileHandle parameter specifies the file that should be updated. The value passed for this parameter must be a file handle obtained from the create_file_direct method; please refer to its documentation for more information.

The InformationClass parameter specifies the class of information to be query. For the list of supported classes, please refer to the documentation of the Windows API's NtQueryInformationFile function.

FileInformation is a buffer that must contain the information queried. The exact size and format of the information depend on InformationClass and are described in the NtQueryInformationFile help topic.

BytesTrasferredThe actual bytes of information received on completion.

query_file_security_direct Method

This method retrieves security information of a file.

Syntax

def query_file_security_direct(file_handle: int, security_information: int, security_descriptor: bytes, length_needed: List[int]) -> None: ...

Remarks

Applications may call this method to query security attributes of the file or directory using the open handle. The method uses the NtQuerySecurityObject Windows API function to change the security attributes.

The FileHandle parameter specifies the file that should be queried. The value passed for this parameter must be a file handle obtained from the create_file_direct method; please refer to its documentation for more information.

The SecurityInformation parameter specifies the information to be queried as a combination of one or more of the following:

OWNER_SECURITY_INFORMATION
GROUP_SECURITY_INFORMATION
DACL_SECURITY_INFORMATION
SACL_SECURITY_INFORMATION

Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to the memory buffer that receives the requested data. It is available only if the length of the buffer is greater than 0. The data must be formatted as a SECURITY_DESCRIPTOR structure in self-relative format. Please refer to these articles for more information about self-relative security descriptors.

The LengthNeeded parameter points to a caller-allocated variable that receives the number of bytes required to store the copied security descriptor.

remove_virtual_file Method

This method removes a virtual file from the list of virtual entries.

Syntax

def remove_virtual_file(file_name: str) -> bool: ...

Remarks

This method removes a previously added virtual file identified by FileName from the list of virtual entries, managed by the class.

The FileName parameter must contain the same value as the one used to add a virtual file earlier.

The method will return True if the file was found and removed from the list and False if the file was not found in the list. An error will be reported if removal of the file failed on the driver side.

reset_timeout Method

This method resets the timeout duration for the current event handler.

Syntax

def reset_timeout(timeout: int) -> bool: ...

Remarks

When event timeouts are being enforced, this method can be called within an event handler to inform the class that request processing is taking longer than expected.

If called successfully, this method returns True, and the current event handler's timeout timer is immediately reset to 0; when it reaches the number of milliseconds specified by Timeout, the driver will either "release" the underlying request and pass it onwards, or cancel it by reporting an error; whichever is most appropriate for the event in question. Please refer to the Timeouts topic for more information.

Passing 0 for Timeout disables the timeout timer for the current event handler, allowing it to take as long as it needs to complete.

Note: When several events are fired for the same file concurrently (if the SerializeAccess configuration setting is disabled), and reset_timeout is called from one of the handlers of these events, this method will reset the timer for all currently executed event handlers.

Note: This method can be called only within events.

set_file_information_direct Method

This method sets the file information of a file opened using CreateFileDirect.

Syntax

def set_file_information_direct(file_handle: int, information_class: int, file_information: bytes) -> None: ...

Remarks

Applications may call this method to change various kinds of information about a file that was opened using the create_file_direct method.

The InformationClass parameter specifies the class of information to be set. For the list of supported classes, please refer to the documentation of the Windows API's FltSetInformationFile function.

Note: Only a limited subset of classes comparing to similar functions like NtSetInformationFile or NtQueryInformationFile is supported by this function.

FileInformation is a buffer that must contain the information to be set. The exact size and format of the information depend on InformationClass and are described in the FltSetInformationFile help topic.

set_file_security_direct Method

This method sets security information of a file.

Syntax

def set_file_security_direct(file_handle: int, security_information: int, security_descriptor: bytes) -> None: ...

Remarks

Applications may call this method to set security attributes of the file or directory using the open handle. The method uses the NtSetSecurityObject Windows API function to query the security attributes.

The SecurityInformation parameter indicates which pieces of security information must be set. This value is a bitfield; possible flags include (but are not limited to):

OWNER_SECURITY_INFORMATION
GROUP_SECURITY_INFORMATION
DACL_SECURITY_INFORMATION
SACL_SECURITY_INFORMATION

Please refer to Microsoft's SECURITY_INFORMATION data-type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that contains data indicated by SecurityInformation. The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format. Please refer to those articles for more information about self-relative security descriptors.

set_file_size_direct Method

This method resizes a file by passing the request directly to the filesystem.

Syntax

def set_file_size_direct(file_handle: int, size: int) -> bool: ...

Remarks

Applications can call this method in filesystem-related event handlers to resize a file without sending the request through the filesystem filter driver stack. If the file is resized successfully, this method returns True; otherwise, it returns False.

The FileHandle parameter specifies the file that should be resized. The value passed for this parameter must be a file handle obtained from the create_file_direct method; please refer to its documentation for more information.

The Size parameter specifies the new file size, in bytes.

To set file allocation size or valid file length, you may use the set_file_information_direct method.

Note: This method can be called only within events.

shutdown_system Method

Shuts down or reboots the operating system.

Syntax

def shutdown_system(shutdown_prompt: str, timeout: int, force_close_apps: bool, reboot: bool) -> bool: ...

Remarks

This method shuts down or (if Reboot is True) reboots the operating system. If the appropriate privileges cannot be obtained, or if the InitiateSystemShutdown system call returns False, then this method will return False; otherwise, it returns True. This method can be used if the installation or uninstallation function requires the system to be rebooted in order to complete.

ShutdownPrompt, if non-empty, specifies a message that the OS should display to the user for Timeout seconds. If empty string is passed for ShutdownPrompt, no message is displayed and the Timeout parameter's value is ignored.

ForceCloseApps specifies whether the OS should forcefully close all applications. Please keep in mind that forceful closing of applications with unsaved data can lead to data loss.

Reboot specifies whether the OS should reboot (True) or just shut down (False).

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

start_filter Method

This method starts filtering filesystem operations.

Syntax

def start_filter(timeout: int) -> None: ...

Remarks

This method attaches the filter, causing the class's system driver to start filtering filesystem operations according to the filter rules currently present. Rules can be added and removed both before and after this method is called, so long as the initialize method is called before doing anything else.

This method can fail for a number of reasons, including (but not limited to) the following:

If the class's system driver has not been properly installed, or is awaiting a system reboot (as indicated by the return value of install), this method fails with an ERROR_FILE_NOT_FOUND (2) error code.
If the initialize method has not been called yet, this method fails with an ERROR_NOT_READY (21) error code.
If the filter is already active, this method fails with an ERROR_CONNECTION_ACTIVE (1230) error code.
If an invalid value is passed for Timeout, this method fails with an ERROR_IMPLEMENTATION_LIMIT (1292) error code.

Timeout

Timeout specifies how many milliseconds the driver should wait for events to execute before releasing or cancelling the underlying OS requests; please refer to the Timeouts topic for more information. Valid values are 0, which disables event timeouts, and values greater than or equal to 3000. When event timeouts are in effect, event handlers can call reset_timeout to reset the timer if they require additional time to complete.

stop_filter Method

This method stops filtering filesystem operations.

Syntax

def stop_filter() -> None: ...

Remarks

This method detaches the filter, causing the class's system driver to stop filtering filesystem operations. This method will block until all pending requests have been completed and the filter has been detached.

suspend_default_rules Method

This method suspends all default rules until the application exits.

Syntax

def suspend_default_rules(product_guid: str) -> bool: ...

Remarks

This method suspends (i.e., deactivates) all default rules associated with the application identified by ProductGUID until the application exits. If the rules are suspended successfully, this method returns True; otherwise, it returns False.

In most cases, the value passed for the ProductGUID parameter should be the same one that was used to call the initialize method.

When the application exits, the class's system driver will reactivate the suspended rules and start enforcing them once again.

suspend_file_events Method

This method suspends all events for a particular file or directory until all of its handles have been closed.

Syntax

def suspend_file_events() -> None: ...

Remarks

Applications can call this method from an on_after_create_file or on_after_open_file event to suspend all further events for the file or directory that the event fired for. The suspension will remain in effect until all handles to said file or directory have been closed, at which point the class will once again fire events for it (if it is accessed again).

Typically, this method should be used only as a "last resort"; that is, when the application cannot achieve the same outcome through the use of more granular standard filter rules. Said another way, it is almost always more efficient for an application to exclude files or directories implicitly using standard filter rules, if possible, than it is to exclude them explicitly using this method.

Note: This method can be called only within the on_after_create_file and on_after_open_file events.

toggle_process_protection Method

This method enables or disables termination protection for the application.

Syntax

def toggle_process_protection(enabled: bool) -> bool: ...

Remarks

This method controls the termination protection mechanism, which applications can enable to prevent their process and threads from being terminated. If successful, this method returns True; otherwise, it returns False.

The Enabled parameter specifies whether termination protection should be enabled (True) or disabled (False); it is disabled by default. If termination protection is enabled, an application must disable it before attempting to exit.

Note: When developing a GUI-based application, please keep in mind that the termination protection mechanism does not intercept Windows' notifications like WM_CLOSE or WM_QUIT; applications must intercept and handle such messages themselves if they wish to protect their UI. Please refer to Microsoft's Window Notifications articles for more information.

uninstall Method

This method uninstalls the class's system driver.

Syntax

def uninstall(cab_file_name: str, product_guid: str, installed_path: str, flags: int) -> bool: ...

Remarks

This method is used to uninstall the class's system driver. If the system must be rebooted to complete the uninstallation process, this method returns True; otherwise, it returns False.

Please refer to the Driver Installation topic for more information.

The same values must be passed for the CabFileName, ProductGUID, and InstalledPath parameters as were passed when install was called; please refer to its documentation for more information.

Flags specifies which versions of the class's system driver should be uninstalled and which should be set by ORing together one or more of the following values:


UNINSTALL_VERSION_PREVIOUS	`0x00000001`	Uninstall modules from previous product versions. Note: This functionality is only available in Windows.
UNINSTALL_VERSION_CURRENT	`0x00000002`	Uninstall modules from the current product version. Note: This functionality is only available in Windows.
UNINSTALL_VERSION_ALL	`0x00000003`	Uninstall modules from all product versions. Note: This functionality is only available in Windows.

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation topic for more information about the latter.

Note: This method cannot be called within events.

update_virtual_file Method

This method updates known information about a virtual file .

Syntax

def update_virtual_file(file_name: str, creation_time: datetime.datetime, last_access_time: datetime.datetime, last_write_time: datetime.datetime, change_time: datetime.datetime, size: int, attributes: int) -> bool: ...

Remarks

This method updates the information about the virtual file identified by FileName.

The FileName parameter must contain the same value as the one used to add a virtual file earlier.

CreationTime, LastAccessTime, LastWriteTime, ChangeTime should contain new time values for the file, specified in UTC; any of the time values may be January 1, 1601 00:00:00 UTC to indicate that the existing value of the corresponding time must remain unchanged.

Size must be set to the new size of the file to update the known file size or to -1 to indicate that the size didn't change.

Attributes must be set to new file's attributes. Set this parameter to 0 to indicate that the existing attributes must remain unchanged.

FILE_ATTRIBUTE_NORMAL: This attribute is valid only when used alone; it "resets" a file's attributes.
Please refer to Microsoft's File Attribute Constants article for attribute descriptions.

The method will return True if the file was found and updated and False if the file was not found in the list. An error will be reported if updating the file failed on the driver side.

on_after_can_file_be_deleted Event

This event fires after the OS marks a file or directory for deletion or removes such a mark.

Syntax

class CBFilterAfterCanFileBeDeletedEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def request_type() -> int: ...

  @property
  def can_delete() -> bool: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_can_file_be_deleted() -> Callable[[CBFilterAfterCanFileBeDeletedEventParams], None]: ...
@on_after_can_file_be_deleted.setter
def on_after_can_file_be_deleted(event_hook: Callable[[CBFilterAfterCanFileBeDeletedEventParams], None]) -> None: ...

Remarks

This event fires after the OS marks the file or directory specified by FileName for deletion or removes such a mark. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

If the file or directory is marked for deletion, they will not be removed immediately but will actually be removed when the last handle is closed. Moreover, it is possible that a future call to a system function will remove the mark, so this event is not a final indicator that the file or directory will be deleted.

Files and directories can be deleted in two ways: (1) a file or directory can be opened with the FILE_FLAG_DELETE_ON_CLOSE flag, or (2) some process may call Windows API's NtSetInformationFile function with FILE_DISPOSITION_INFORMATION or FILE_DISPOSITION_INFORMATION_EX structure as a parameter.

If the file or directory is created or opened with the FILE_FLAG_DELETE_ON_CLOSE flag, this event is fired shortly after the on_after_create_file or on_after_open_file event.

The RequestType indicates which kind of system request resulted in firing this event. It can be one of the following:


DEL_REQ_OPEN_FLAG	`0x1`	The file or directory is opened with the FILE_FLAG_DELETE_ON_CLOSE flag
DEL_REQ_SET_DISPOSITION	`0x2`	The system has sent the IRP_MJ_SET_INFORMATION request with SetFileDisposition structure as a parameter. This request usually is sent using the `NtSetInformationFile()` Windows native API function.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_CAN_DELETE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The CanDelete parameter reflects whether the file or directory will be deleted.

The Status parameter contains an NT status code that indicates the outcome of the operation; 0 indicates success. To convert this value to a Win32 error code, call the nt_status_to_win32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled. Applications may change this parameter's value if they want a different NT status code to be returned.

The EventContext parameter makes it possible to pass information between Before* and After* events that are related to the same OS request. 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 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 is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Handling topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_cleanup_file Event

This event fires after a file or directory handle is closed.

Syntax

class CBFilterAfterCleanupFileEventParams(object):
  @property
  def file_name() -> str: ...

  @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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_cleanup_file() -> Callable[[CBFilterAfterCleanupFileEventParams], None]: ...
@on_after_cleanup_file.setter
def on_after_cleanup_file(event_hook: Callable[[CBFilterAfterCleanupFileEventParams], None]) -> None: ...

Remarks

This event fires after a handle to the file or directory specified by FileName is closed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event differs from on_after_close_file in that on_after_cleanup_file fires immediately after an open handle to the specified file or directory is closed by a process, whereas on_after_close_file may be fired much later when the OS decides that the file or directory can be formally closed.

Other events may fire for the file or directory in the time between when this event fires and when the on_after_close_file event fires. For example, system components, such as the memory manager or cache manager, may cause the on_after_read_file and on_after_write_file events to fire.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_CLEANUP flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_close_enumeration Event

This event fires after a directory enumeration operation finishes.

Syntax

class CBFilterAfterCloseEnumerationEventParams(object):
  @property
  def directory_name() -> str: ...

  @property
  def directory_context() -> int: ...

  @property
  def handle_context() -> int: ...

  @property
  def enumeration_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_close_enumeration() -> Callable[[CBFilterAfterCloseEnumerationEventParams], None]: ...
@on_after_close_enumeration.setter
def on_after_close_enumeration(event_hook: Callable[[CBFilterAfterCloseEnumerationEventParams], None]) -> None: ...

Remarks

This event fires after enumeration of the directory specified by DirectoryName finishes. For more information about the DirectoryName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_CLOSE flag (directory enumerations are typically closed immediately before a directory is closed).

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The EnumerationContext parameter is a placeholder for application-defined data associated with the enumeration. Please refer to the Contexts topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_close_file Event

This event fires after a file or directory is closed.

Syntax

class CBFilterAfterCloseFileEventParams(object):
  @property
  def file_name() -> str: ...

  @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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_close_file() -> Callable[[CBFilterAfterCloseFileEventParams], None]: ...
@on_after_close_file.setter
def on_after_close_file(event_hook: Callable[[CBFilterAfterCloseFileEventParams], None]) -> None: ...

Remarks

This event fires after the file or directory specified by FileName is closed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_CLOSE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

If the file or directory was marked for deletion earlier, the on_after_delete_file will fire shortly before this event.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_create_file Event

This event fires after a file or directory is created.

Syntax

class CBFilterAfterCreateFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def existing_attributes() -> int: ...

  @property
  def isolate() -> bool: ...

  @property
  def backend_file_name() -> str: ...

  @property
  def desired_access() -> int: ...

  @property
  def attributes() -> int: ...

  @property
  def share_mode() -> int: ...

  @property
  def options() -> int: ...

  @property
  def create_disposition() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def creation_status() -> int: ...
  @creation_status.setter
  def creation_status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_create_file() -> Callable[[CBFilterAfterCreateFileEventParams], None]: ...
@on_after_create_file.setter
def on_after_create_file(event_hook: Callable[[CBFilterAfterCreateFileEventParams], None]) -> None: ...

Remarks

This event fires after the file or directory specified by FileName is created. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. Please refer to the File Create/Open Events topic for more information about how the class determines whether to fire this event or on_after_open_file.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_CREATE flag.

Note: Applications must have the FilterOwnRequests configuration setting enabled if they wish to filter their own file/directory creation requests.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

When extended rules are used or the AlwaysRequestAttributesOnOpen configuration setting is enabled, the driver requests attributes of the entity from the filesystem and passes them to ExistingAttributes. If the attributes are not requested, this parameter contains 0.

If Isolate was set to True in the on_before_create_file or on_before_open_file events, the value of the Isolate and BackendFileName parameters in this event will contain the values initially set in those events. Additionally, if a file was added using the add_virtual_file method Isolate will be True.

The DesiredAccess, Attributes, ShareMode, and CreateDisposition parameters reflect the values that were passed for the similarly named parameters of the Windows API's CreateFile function (or, more accurately, the values carried by the IRP_MJ_CREATE IRP).

DesiredAccess may contain one or more of the following access flags:


DESIRED_ACCESS_FILE_LIST_DIRECTORY	`0x00000001`	For a directory, the right to list the contents of the directory.
DESIRED_ACCESS_FILE_READ_DATA	`0x00000001`	For a file object, the right to read the corresponding file data. For a directory object, the right to read the corresponding directory data.
DESIRED_ACCESS_FILE_ADD_FILE	`0x00000002`	For a directory, the right to create a file in the directory.
DESIRED_ACCESS_FILE_WRITE_DATA	`0x00000002`	For a file object, the right to write data to the file. For a directory object, the right to create a file in the directory
DESIRED_ACCESS_FILE_ADD_SUBDIRECTORY	`0x00000004`	For a directory, the right to create a subdirectory.
DESIRED_ACCESS_FILE_APPEND_DATA	`0x00000004`	For a file object, the right to append data to the file. (For local files, write operations will not overwrite existing data if this flag is specified without FILE_WRITE_DATA.) For a directory object, the right to create a subdirectory (FILE_ADD_SUBDIRECTORY).
DESIRED_ACCESS_FILE_READ_EA	`0x00000008`	The right to read extended file attributes.
DESIRED_ACCESS_FILE_WRITE_EA	`0x00000010`	The right to write extended file attributes.
DESIRED_ACCESS_FILE_EXECUTE	`0x00000020`	For a native code file, the right to execute the file. This access right given to scripts may cause the script to be executable, depending on the script interpreter.
DESIRED_ACCESS_FILE_DELETE_CHILD	`0x00000040`	For a directory, the right to delete a directory and all the files it contains, including read-only files.
DESIRED_ACCESS_FILE_READ_ATTRIBUTES	`0x00000080`	The right to read file attributes.
DESIRED_ACCESS_FILE_WRITE_ATTRIBUTES	`0x00000100`	The right to write file attributes.
DESIRED_ACCESS_READ_CONTROL	`0x00020000`	The right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_READ	`0x00020000`	Includes READ_CONTROL, which is the right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_WRITE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_STANDARD_RIGHTS_EXECUTE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_SYNCHRONIZE	`0x00100000`	The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.
DESIRED_ACCESS_FILE_ALL_ACCESS	`0x001F01FF`	All possible access rights for a file.
DESIRED_ACCESS_FILE_GENERIC_READ	`0x00120089`	A combinarion of flags that allow reading of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_WRITE	`0x00120116`	A combinarion of flags that allow modifications to the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_EXECUTE	`0x001200A0`	A combinarion of flags that allow execution of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Attributes may contain one or more of the following attributes:


FILE_SYS_ATTR_READ_ONLY	`0x00000001`	The file is read-only. Applications can read the file, but cannot write to it or delete it. This attribute is not honored on directories.
FILE_SYS_ATTR_HIDDEN	`0x00000002`	The file or directory is hidden. The file is not included in an ordinary directory listing.
FILE_SYS_ATTR_SYSTEM	`0x00000004`	A file or directory that the operating system uses a part of, or uses exclusively.
FILE_SYS_ATTR_DIRECTORY	`0x00000010`	The entry is a directory.
FILE_SYS_ATTR_ARCHIVE	`0x00000020`	The entry is an archive file or directory. Applications typically use this attribute to mark files for backup or removal.
FILE_SYS_ATTR_NORMAL	`0x00000080`	A file doesn't have other attributes set. This attribute is valid only when used alone.
FILE_SYS_ATTR_TEMPORARY	`0x00000100`	A file that is being used for temporary storage. File systems avoid writing data back to mass storage if sufficient cache memory is available, because typically, an application deletes a temporary file after the handle is closed. In that scenario, the system can entirely avoid writing the data. Otherwise, the data are written after the handle is closed.
FILE_SYS_ATTR_SPARSE_FILE	`0x00000200`	A file that is a sparse file.
FILE_SYS_ATTR_REPARSE_POINT	`0x00000400`	A file that is a reparse point or a symbolic link.
FILE_SYS_ATTR_COMPRESSED	`0x00000800`	A file or directory that is compressed. For a file, all of the data in the file are compressed. For a directory, compression is the default for newly created files and subdirectories. A filesystem implementation can make use of this attribute by setting the support_compressed_attribute property to `True` and then properly handling the on_get_file_info, on_enumerate_directory, and on_set_file_attributes events.
FILE_SYS_ATTR_OFFLINE	`0x00001000`	The data of a file are not available immediately. This attribute indicates that the file data are physically moved to offline storage.
FILE_SYS_ATTR_NOT_CONTENT_INDEXED	`0x00002000`	The file or directory is not to be indexed by the content indexing service.
FILE_SYS_ATTR_ENCRYPTED	`0x00004000`	A file or directory that is encrypted. For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories. Note: This flag is used by NTFS and the OS sends undocumented requests to the filesystem based on this flag. The flag should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_VIRTUAL	`0x00010000`	Reserved. Note: This flag is reserved by the OS and should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_RECALL_ON_OPEN	`0x00040000`	The file or directory has no physical representation on the local system; the item is virtual. Opening the item will be more expensive than normal (e.g., it will cause at least some of it to be fetched from a remote store). This flag is reported by filesystems during directory enumerations.

ShareMode may contain zero or more of the following share mode flags:


FILESYS_SHARE_READ	`0x00000001`	Enables subsequent open operations on a file or device to request read access. Enables subsequent open operations to request read access; otherwise, no process can open the file or device if it requests read access. If this flag is not specified, but the file or device has been opened for read access, the function fails.
FILESYS_SHARE_WRITE	`0x00000002`	Enables subsequent open operations on a file or device to request write access. Enables subsequent open operations to request write access; otherwise, no process can open the file or device if it requests write access. If this flag is not specified, but the file or device has been opened for write access or has a file mapping with write access, the function fails.
FILESYS_SHARE_DELETE	`0x00000004`	Enables subsequent open operations on a file or device to request delete access. Enables subsequent open operations to request delete access; otherwise, no process can open the file or device if it requests delete access. If this flag is not specified, but the file or device has been opened for delete access, the function fails. Note: Delete access allows both delete and rename operations.

CreateDisposition may contain one of the following values:


FILE_DISPOSITION_CREATE_NEW	`0x00000001`	Creates a new file, only if it does not already exist. If the specified file exists, the operation fails with an "already exists" error.
FILE_DISPOSITION_CREATE_ALWAYS	`0x00000002`	Creates a new file, always. If the specified file exists and is writable, the system overwrites the file. If the specified file does not exist and is a valid path, a new file is created.
FILE_DISPOSITION_OPEN_EXISTING	`0x00000003`	Opens a file, only if it exists If the specified file does not exist, opening fails.
FILE_DISPOSITION_OPEN_ALWAYS	`0x00000004`	Opens a file, always. If the specified file exists, the operation succeeds. If the specified file does not exist and is a valid path to a writable location, the a file is created.
FILE_DISPOSITION_TRUNCATE_EXISTING	`0x00000005`	Opens a file and truncates it so that its size is zero bytes, only if it exists. If the specified file does not exist, the operation fails with a "file not found" error.

Options contains the flags that are described in the CreateOptions parameter of the native API's ZwCreateFile function. Most of those flags correspond to flags passed in the FlagsAndAttributes parameter of the Windows API's CreateFile function, but some flags are specific to the native API. If you need those flags, check both functions' descriptions.

Please refer to Microsoft's documentation for detailed information about these constants.

To determine whether the request was for a file or a directory, compare Attributes against the FILE_SYS_ATTR_DIRECTORY constant, as follows: // Check whether the request is for a file or a directory. bool isDirectory = Attributes & FILE_SYS_ATTR_DIRECTORY == FILE_SYS_ATTR_DIRECTORY; FILE_SYS_ATTR_DIRECTORY will be present if it was specified by the calling process or if the existing filesystem entry is a directory.

To determine whether a file will be deleted when its last handle is closed, compare Options against the Windows API's FILE_FLAG_DELETE_ON_CLOSE constant, as follows: // Check whether the file will be deleted on close. bool deleteOnClose = Options & FILE_FLAG_DELETE_ON_CLOSE == FILE_FLAG_DELETE_ON_CLOSE; Note: Because files can be deleted in different ways, do not use this check to take actions related to tracking file deletion operations. Instead, use the events related to file deletion.

When a file or directory is created using the CreateFile() Windows API function, a caller can specify the security descriptor with the security information. This security information should be applied to a newly created file or directory. The class passes this security information in the SecurityInformation and SecurityDescriptor parameters, when the PassSecurityInFileOpenEvents configuration setting is enabled. If this configuration setting is omitted, the corresponding parameters are empty.

The SecurityInformation parameter reflects which pieces of security information, of those present in SecurityDescriptor, are valid and should have been applied. Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that contains the security information. The Length parameter reflects the length of this data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

If the Options contains the FILE_FLAG_DELETE_ON_CLOSE flag, the on_after_can_file_be_deleted event will fire after this event.

If the file is created with Extended Attributes passed in the request, the on_after_set_ea event will fire after this event.

The CreationStatus parameter indicates whether the file was created or opened and can be one of the following values:


CREATION_STATUS_SUPERSEDED	`0x00000000`	An existing file was superseded by the new file. The previous version of a file may still exist if it had hard links other than the name used in the operation.
CREATION_STATUS_OPENED	`0x00000001`	The file existed before the operation and was opened.
CREATION_STATUS_CREATED	`0x00000002`	The file didn't exist before the operation and was created.
CREATION_STATUS_OVERWRITTEN	`0x00000003`	The file exists, and its contents have been replaced.
CREATION_STATUS_EXISTS	`0x00000004`	The file existed before the operation, and no action was taken.
CREATION_STATUS_DOES_NOT_EXIST	`0x000000055`	The file did not exist before the operation, and no action was taken.

Applications may change this parameter's value if they want a different creation status code to be returned.

When the process_failed_requests property is enabled, this event may fire even if the specified file or directory has not been created or opened, in which case the Status parameter will be non-zero. When this occurs, applications must not alter the FileContext and HandleContext parameters.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_create_hard_link Event

This event fires after a hard link is created.

Syntax

class CBFilterAfterCreateHardLinkEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def link_name() -> str: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_create_hard_link() -> Callable[[CBFilterAfterCreateHardLinkEventParams], None]: ...
@on_after_create_hard_link.setter
def on_after_create_hard_link(event_hook: Callable[[CBFilterAfterCreateHardLinkEventParams], None]) -> None: ...

Remarks

This event fires after a hard link to the file specified by FileName is created. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. Please refer to Microsoft's Hard Links article for more information about hard links.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_CREATE_HARD_LINK flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The LinkName parameter reflects the name of the created hard link.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_delete_file Event

This event fires after a file or directory is deleted.

Syntax

class CBFilterAfterDeleteFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def request_type() -> int: ...

  @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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_delete_file() -> Callable[[CBFilterAfterDeleteFileEventParams], None]: ...
@on_after_delete_file.setter
def on_after_delete_file(event_hook: Callable[[CBFilterAfterDeleteFileEventParams], None]) -> None: ...

Remarks

This event fires after the file or directory specified by FileName is deleted. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. More specifically, this event is fired after the final IRP_MJ_CLOSE IRP is processed by the filesystem (i.e., after the last handle to the file or directory is closed and the file or directory is gone) and before on_after_close_file fires.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_DELETE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The RequestType indicates which kind of system request resulted in firing this event. It can be one of the following:


DEL_REQ_OPEN_FLAG	`0x1`	The file or directory is opened with the FILE_FLAG_DELETE_ON_CLOSE flag
DEL_REQ_SET_DISPOSITION	`0x2`	The system has sent the IRP_MJ_SET_INFORMATION request with SetFileDisposition structure as a parameter. This request usually is sent using the `NtSetInformationFile()` Windows native API function.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_delete_reparse_point Event

This event fires after the OS deletes a reparse point from a file or directory.

Syntax

class CBFilterAfterDeleteReparsePointEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def reparse_buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_delete_reparse_point() -> Callable[[CBFilterAfterDeleteReparsePointEventParams], None]: ...
@on_after_delete_reparse_point.setter
def on_after_delete_reparse_point(event_hook: Callable[[CBFilterAfterDeleteReparsePointEventParams], None]) -> None: ...

Remarks

This event fires after the OS deletes a reparse point from a file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Note: The file or directory is not deleted, only a reparse point is.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_DELETE_REPARSE_POINT flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The ReparseBuffer parameter points to a memory buffer that specifies the known reparse point information. This information is provided for convenience. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

Please refer to the Reparse Points topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_enumerate_directory Event

This event fires after a directory entry is returned during directory enumeration.

Syntax

class CBFilterAfterEnumerateDirectoryEventParams(object):
  @property
  def directory_name() -> str: ...

  @property
  def flags() -> int: ...

  @property
  def index() -> int: ...

  @property
  def file_name() -> str: ...
  @file_name.setter
  def file_name(value) -> None: ...

  @property
  def creation_time() -> datetime.datetime: ...
  @creation_time.setter
  def creation_time(value) -> None: ...

  @property
  def last_access_time() -> datetime.datetime: ...
  @last_access_time.setter
  def last_access_time(value) -> None: ...

  @property
  def last_write_time() -> datetime.datetime: ...
  @last_write_time.setter
  def last_write_time(value) -> None: ...

  @property
  def change_time() -> datetime.datetime: ...
  @change_time.setter
  def change_time(value) -> None: ...

  @property
  def size() -> int: ...
  @size.setter
  def size(value) -> None: ...

  @property
  def allocation_size() -> int: ...
  @allocation_size.setter
  def allocation_size(value) -> None: ...

  @property
  def file_id() -> int: ...
  @file_id.setter
  def file_id(value) -> None: ...

  @property
  def attributes() -> int: ...
  @attributes.setter
  def attributes(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def directory_context() -> int: ...
  @directory_context.setter
  def directory_context(value) -> None: ...

  @property
  def handle_context() -> int: ...
  @handle_context.setter
  def handle_context(value) -> None: ...

  @property
  def event_context() -> int: ...

  @property
  def enumeration_context() -> int: ...
  @enumeration_context.setter
  def enumeration_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_after_enumerate_directory() -> Callable[[CBFilterAfterEnumerateDirectoryEventParams], None]: ...
@on_after_enumerate_directory.setter
def on_after_enumerate_directory(event_hook: Callable[[CBFilterAfterEnumerateDirectoryEventParams], None]) -> None: ...

Remarks

This event fires after a directory entry (i.e., a file or subdirectory) is returned during enumeration of the directory specified by DirectoryName. For more information about the DirectoryName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications may use this event to modify the entry's metadata before it gets reported to the requestor or even to prevent the entry from being reported in the first place.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_ENUMERATE_DIRECTORY flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Flags parameter specifies supplementary information about enumeration. It is a combination of zero or more values:


FS_ENUM_RESTART_SCAN	`1`	The requestor specified that directory enumeration must be restarted.
FS_ENUM_RETURN_SINGLE_ENTRY	`2`	One entry should be returned.
FS_ENUM_INDEX_SPECIFIED	`4`	The requestor specified the index to start enumeration from.

If the Flags parameter contains FS_ENUM_INDEX_SPECIFIED, the Index parameter contains the index as provided by the OS.

The FileName parameter reflects the name of the directory entry. .

The CreationTime, LastAccessTime, LastWriteTime, and ChangeTime parameters specify the entry's time values, specified in UTC.

The Size parameter specifies the size of the file, in bytes; it must always be 0 for subdirectories.

The AllocationSize parameter specifies the amount of space allocated for the file, in bytes; it must always be 0 for subdirectories.

The FileId parameter specifies the unique Id of the entry, as reported by the filesystem (or, for virtual files, by the application itself). This Id is used by the network redirector, and some third-party applications, to open files and directories by Id instead of by name. The root directory always uses the predefined Id 0x7FFFFFFFFFFFFFFF.

The Attributes parameter specifies the entry's attributes; please refer to Microsoft's File Attribute Constants article for attribute descriptions.

The DirectoryContext, HandleContext, and EnumerationContext parameters are placeholders for application-defined data associated with the directory, specific handle, and enumeration, respectively. (For general-purpose events, the DirectoryContext is called FileContext instead.) DirectoryContext corresponds to the FileContext in the file/directory creation, opening, and closing events. Please refer to the Contexts topic for more information.

The ProcessRequest parameter controls whether the directory entry should actually be reported to the requestor; it is True by default. Setting this parameter to False will "hide" the directory entry (i.e., prevent it from being reported).

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_filter_attach_to_volume Event

This event fires after the filter attaches to a newly mounted filesystem volume.

Syntax

class CBFilterAfterFilterAttachToVolumeEventParams(object):
  @property
  def volume_name() -> str: ...

  @property
  def volume_name_nt() -> str: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_filter_attach_to_volume() -> Callable[[CBFilterAfterFilterAttachToVolumeEventParams], None]: ...
@on_after_filter_attach_to_volume.setter
def on_after_filter_attach_to_volume(event_hook: Callable[[CBFilterAfterFilterAttachToVolumeEventParams], None]) -> None: ...

Remarks

This event fires after the filter attaches to the newly mounted filesystem volume specified by VolumeNameNT and, when possible, VolumeName. Please refer to the fire_volume_events property for more information.

Applications need to handle this event only if the fire_volume_events property includes the FS_MOUNT_CONTROL flag.

Note: This event won't fire for any volumes skipped during the on_before_filter_attach_to_volume event; please refer to its documentation for more information.

VolumeNameNT contains the name of the volume in the NT-native format, as received from the system. If the ResolveNtDeviceToDriveLetter configuration setting is enabled, and if it was possible to convert the NT name to the DOS format with a drive letter, VolumeName will contain the name in this format; otherwise, it will be empty.

Applications can obtain additional information about a volume by retrieving its GUID using the get_volume_guid method, and then using that GUID to call various Windows API functions.

Applications can use this event to add volume-specific rules for the volume that has been mounted (keeping in mind that this event does not fire for volumes that are already present when start_filter is called). Applications that intend to do so must ensure that proper thread synchronization techniques are used when manipulating or enumerating the rule lists, because this event's handler will always execute in the context of some worker thread. Note: if a path-based rule is added or removed, such a path should use the value from VolumeNameNT to avoid a possible deadlock, which may occur during resolving a DOS name to the NT format.

Applications must be aware that this event fires as a direct response to a filesystem state change (mount or unmount). Various system components or third-party actors can perform supplementary filesystem mounting and unmounting during main unmount operations (e.g., Volume Service is one such component). This can cause seemingly excessive events to be fired, and sometimes they can be fired out of order (such as two *Attach or *Detach events fired in a row).

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_filter_detach_from_volume Event

This event fires after the filter detaches from a filesystem volume.

Syntax

class CBFilterAfterFilterDetachFromVolumeEventParams(object):
  @property
  def volume_name() -> str: ...

  @property
  def volume_name_nt() -> str: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_filter_detach_from_volume() -> Callable[[CBFilterAfterFilterDetachFromVolumeEventParams], None]: ...
@on_after_filter_detach_from_volume.setter
def on_after_filter_detach_from_volume(event_hook: Callable[[CBFilterAfterFilterDetachFromVolumeEventParams], None]) -> None: ...

Remarks

This event fires after the filter detaches from the filesystem volume specified by VolumeNameNT and, when possible, VolumeName, typically because of the volume being unmounted. Please refer to the fire_volume_events property for more information.

Applications need to handle this event only if the fire_volume_events property includes the FS_MOUNT_CONTROL flag.

Note: This event won't fire for any volumes skipped during the on_before_filter_attach_to_volume event; please refer to its documentation for more information.

Applications should use this event to remove volume-specific rules for the volume that has been unmounted. Applications that intend to do so must ensure that proper thread synchronization techniques are used when manipulating or enumerating the rule lists, because this event's handler will always execute in the context of some worker thread. Note: if a path-based rule is added or removed, such a path should use the value from VolumeNameNT to avoid a possible deadlock, which may occur during resolving a DOS name to the NT format.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_fsctl Event

This event fires after an IRP_MJ_FILE_SYSTEM_CONTROL request is processed.

Syntax

class CBFilterAfterFsctlEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def fs_control_code() -> int: ...

  @property
  def in_buffer() -> c_void_p: ...

  @property
  def in_buffer_length() -> int: ...

  @property
  def in_buffer_valid_bytes() -> int: ...

  @property
  def out_buffer() -> c_void_p: ...

  @property
  def out_buffer_length() -> int: ...

  @property
  def out_buffer_valid_bytes() -> int: ...
  @out_buffer_valid_bytes.setter
  def out_buffer_valid_bytes(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_fsctl() -> Callable[[CBFilterAfterFsctlEventParams], None]: ...
@on_after_fsctl.setter
def on_after_fsctl(event_hook: Callable[[CBFilterAfterFsctlEventParams], None]) -> None: ...

Remarks

This event fires after an IRP_MJ_FILE_SYSTEM_CONTROL (FSCTL) request is processed. Such requests are sent using the Windows API's DeviceIoControl function (user mode), or ZwFsControlFile function (kernel mode); please refer to Microsoft's documentation for more information.

Applications may use this event to modify the output data (if there are any) before the response is returned to the requestor. Applications that choose to do this must:

copy no more than OutBufferLength bytes into OutBuffer; and
update the OutBufferValidBytes parameter's value afterward so that it correctly reflects the amount of data in OutBuffer.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_FSCTL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The FileName parameter reflects the file, directory, or volume targeted by the request.

The FsControlCode parameter reflects the requested filesystem control code (FSCTL).

The InBuffer parameter points to a memory buffer that contains the data required to perform the operation. The InBufferLength and InBufferValidBytes parameters reflect the capacity of InBuffer and the length of the data it contains (respectively), in bytes; InBufferValidBytes may be less than InBufferLength (unless the request did not include data, in which case both will be 0).

The OutBuffer parameter points to a memory buffer that contains the data returned by the operation. The OutBufferLength and OutBufferValidBytes parameters reflect the capacity of OutBuffer and the length of the data it contains (respectively), in bytes; OutBufferValidBytes may be less than OutBufferLength (unless the operation did not return data, in which case both will be 0).

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_get_file_security Event

This event fires after a file or directory's security attributes are retrieved.

Syntax

class CBFilterAfterGetFileSecurityEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def length_needed() -> int: ...
  @length_needed.setter
  def length_needed(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_get_file_security() -> Callable[[CBFilterAfterGetFileSecurityEventParams], None]: ...
@on_after_get_file_security.setter
def on_after_get_file_security(event_hook: Callable[[CBFilterAfterGetFileSecurityEventParams], None]) -> None: ...

Remarks

This event fires after security attributes are retrieved for the file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Note: This event will not fire every time a file or directory is accessed. To check file security upon each access to a file or directory, implement the file create and open events and perform the necessary checks there instead.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_GET_SECURITY flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The SecurityInformation parameter indicates which pieces of security information were requested. Please refer to Microsoft's SECURITY_INFORMATION data-type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that, if the request was successful, contains the requested security information. The Length parameter reflects the length of this data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

Applications that wish to modify the security information may do so by replacing the data in the SecurityDescriptor buffer. If the current Length is too small to accommodate the new security information, set LengthNeeded to the number of bytes necessary to hold the data and return the ERROR_INSUFFICIENT_BUFFER error code via ResultCode.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_get_file_sizes Event

This event fires after a file's size information is retrieved.

Syntax

class CBFilterAfterGetFileSizesEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def size() -> int: ...
  @size.setter
  def size(value) -> None: ...

  @property
  def allocation_size() -> int: ...
  @allocation_size.setter
  def allocation_size(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_get_file_sizes() -> Callable[[CBFilterAfterGetFileSizesEventParams], None]: ...
@on_after_get_file_sizes.setter
def on_after_get_file_sizes(event_hook: Callable[[CBFilterAfterGetFileSizesEventParams], None]) -> None: ...

Remarks

This event fires after size information is retrieved for the file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications that intend to modify a file's contents should use this event to modify the file's actual size or allocation size as necessary. Applications that make use of virtual files should use this event to report the size of the virtual files.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_GET_SIZES flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Size parameter specifies the actual size of the file, in bytes.

The AllocationSize parameter specifies the amount of space allocated for the file, in bytes.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_get_reparse_point Event

This event fires after a file or directory's reparse point information is retrieved.

Syntax

class CBFilterAfterGetReparsePointEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def reparse_buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def data_length() -> int: ...
  @data_length.setter
  def data_length(value) -> None: ...

  @property
  def length_needed() -> int: ...
  @length_needed.setter
  def length_needed(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_get_reparse_point() -> Callable[[CBFilterAfterGetReparsePointEventParams], None]: ...
@on_after_get_reparse_point.setter
def on_after_get_reparse_point(event_hook: Callable[[CBFilterAfterGetReparsePointEventParams], None]) -> None: ...

Remarks

This event fires after reparse point information is retrieved for the file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_GET_REPARSE_POINT flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The ReparseBuffer parameter points to a memory buffer that, if the request was successful, contains the requested reparse point information. The DataLength parameter reflects the length of this data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

Please refer to the Reparse Points topic for more information.

Applications that wish to modify the reparse point information may do so by replacing the data in the ReparseBuffer buffer. If the current BufferLength is too small to accommodate the new information, the application should write as much data as possible, set LengthNeeded appropriately, and return the STATUS_BUFFER_OVERFLOW status code via Status.

Depending on how the request originator accessed the specified file or directory, it may or may not currently be open. The FileContext and HandleContext parameters will be absent if it is not open, in which case they will be None.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_ioctl Event

This event fires after an IRP_MJ_DEVICE_CONTROL request is processed.

Syntax

class CBFilterAfterIoctlEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def io_control_code() -> int: ...

  @property
  def in_buffer() -> c_void_p: ...

  @property
  def in_buffer_length() -> int: ...

  @property
  def in_buffer_valid_bytes() -> int: ...

  @property
  def out_buffer() -> c_void_p: ...

  @property
  def out_buffer_length() -> int: ...

  @property
  def out_buffer_valid_bytes() -> int: ...
  @out_buffer_valid_bytes.setter
  def out_buffer_valid_bytes(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_ioctl() -> Callable[[CBFilterAfterIoctlEventParams], None]: ...
@on_after_ioctl.setter
def on_after_ioctl(event_hook: Callable[[CBFilterAfterIoctlEventParams], None]) -> None: ...

Remarks

This event fires after an IRP_MJ_DEVICE_CONTROL (IOCTL) request is processed. Such requests are sent using the Windows API's DeviceIoControl function (user mode), or ZwDeviceIoControlFile function (kernel mode). Please refer to Microsoft's documentation for more information.

Applications may use this event to modify the output data (if there are any) before the response is returned to the requestor. Applications that choose to do this must:

copy no more than OutBufferLength bytes into OutBuffer; and
update the OutBufferValidBytes parameter's value afterward so that it correctly reflects the amount of data in OutBuffer.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_IOCTL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The FileName parameter reflects the file, directory, or volume targeted by the request.

The IoControlCode parameter reflects the requested I/O control code (IOCTL).

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_lock Event

This event fires after a range of bytes in a file is locked.

Syntax

class CBFilterAfterLockEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def offset() -> int: ...

  @property
  def length() -> int: ...

  @property
  def key() -> int: ...

  @property
  def fail_immediately() -> bool: ...

  @property
  def exclusive_lock() -> bool: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_lock() -> Callable[[CBFilterAfterLockEventParams], None]: ...
@on_after_lock.setter
def on_after_lock(event_hook: Callable[[CBFilterAfterLockEventParams], None]) -> None: ...

Remarks

This event fires after a range of bytes in the file specified by FileName is locked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This request is made either by the OS, or on behalf of a user mode application that called the Windows API's LockFile or LockFileEx function.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_LOCK_CONTROL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Offset parameter reflects the byte offset where the byte range lock starts.

The Length parameter reflects the length of the byte range lock.

The Key parameter reflects the key that the byte range lock is associated with. This key is used to identify the byte range lock in later unlock-by-key requests.

The FailImmediately parameter indicates whether the request was to fail if the lock could not be granted immediately.

The ExclusiveLock parameter indicates whether the byte range lock was to be exclusive (True) or shared (False).

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_open_file Event

This event fires after a file or directory is opened.

Syntax

class CBFilterAfterOpenFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def existing_attributes() -> int: ...

  @property
  def isolate() -> bool: ...

  @property
  def backend_file_name() -> str: ...

  @property
  def desired_access() -> int: ...

  @property
  def attributes() -> int: ...

  @property
  def share_mode() -> int: ...

  @property
  def options() -> int: ...

  @property
  def create_disposition() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(value) -> None: ...

  @property
  def creation_status() -> int: ...
  @creation_status.setter
  def creation_status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_open_file() -> Callable[[CBFilterAfterOpenFileEventParams], None]: ...
@on_after_open_file.setter
def on_after_open_file(event_hook: Callable[[CBFilterAfterOpenFileEventParams], None]) -> None: ...

Remarks

This event fires after the file or directory specified by FileName is opened. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. Please refer to the File Create/Open Events topic for more information about how the class determines whether to fire this event or on_after_create_file.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_OPEN flag.

Note: Applications must have the FilterOwnRequests configuration setting enabled if they wish to filter their own file/directory open requests.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

DesiredAccess may contain one or more of the following access flags:


DESIRED_ACCESS_FILE_LIST_DIRECTORY	`0x00000001`	For a directory, the right to list the contents of the directory.
DESIRED_ACCESS_FILE_READ_DATA	`0x00000001`	For a file object, the right to read the corresponding file data. For a directory object, the right to read the corresponding directory data.
DESIRED_ACCESS_FILE_ADD_FILE	`0x00000002`	For a directory, the right to create a file in the directory.
DESIRED_ACCESS_FILE_WRITE_DATA	`0x00000002`	For a file object, the right to write data to the file. For a directory object, the right to create a file in the directory
DESIRED_ACCESS_FILE_ADD_SUBDIRECTORY	`0x00000004`	For a directory, the right to create a subdirectory.
DESIRED_ACCESS_FILE_APPEND_DATA	`0x00000004`	For a file object, the right to append data to the file. (For local files, write operations will not overwrite existing data if this flag is specified without FILE_WRITE_DATA.) For a directory object, the right to create a subdirectory (FILE_ADD_SUBDIRECTORY).
DESIRED_ACCESS_FILE_READ_EA	`0x00000008`	The right to read extended file attributes.
DESIRED_ACCESS_FILE_WRITE_EA	`0x00000010`	The right to write extended file attributes.
DESIRED_ACCESS_FILE_EXECUTE	`0x00000020`	For a native code file, the right to execute the file. This access right given to scripts may cause the script to be executable, depending on the script interpreter.
DESIRED_ACCESS_FILE_DELETE_CHILD	`0x00000040`	For a directory, the right to delete a directory and all the files it contains, including read-only files.
DESIRED_ACCESS_FILE_READ_ATTRIBUTES	`0x00000080`	The right to read file attributes.
DESIRED_ACCESS_FILE_WRITE_ATTRIBUTES	`0x00000100`	The right to write file attributes.
DESIRED_ACCESS_READ_CONTROL	`0x00020000`	The right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_READ	`0x00020000`	Includes READ_CONTROL, which is the right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_WRITE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_STANDARD_RIGHTS_EXECUTE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_SYNCHRONIZE	`0x00100000`	The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.
DESIRED_ACCESS_FILE_ALL_ACCESS	`0x001F01FF`	All possible access rights for a file.
DESIRED_ACCESS_FILE_GENERIC_READ	`0x00120089`	A combinarion of flags that allow reading of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_WRITE	`0x00120116`	A combinarion of flags that allow modifications to the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_EXECUTE	`0x001200A0`	A combinarion of flags that allow execution of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Attributes may contain one or more of the following attributes:


FILE_SYS_ATTR_READ_ONLY	`0x00000001`	The file is read-only. Applications can read the file, but cannot write to it or delete it. This attribute is not honored on directories.
FILE_SYS_ATTR_HIDDEN	`0x00000002`	The file or directory is hidden. The file is not included in an ordinary directory listing.
FILE_SYS_ATTR_SYSTEM	`0x00000004`	A file or directory that the operating system uses a part of, or uses exclusively.
FILE_SYS_ATTR_DIRECTORY	`0x00000010`	The entry is a directory.
FILE_SYS_ATTR_ARCHIVE	`0x00000020`	The entry is an archive file or directory. Applications typically use this attribute to mark files for backup or removal.
FILE_SYS_ATTR_NORMAL	`0x00000080`	A file doesn't have other attributes set. This attribute is valid only when used alone.
FILE_SYS_ATTR_TEMPORARY	`0x00000100`	A file that is being used for temporary storage. File systems avoid writing data back to mass storage if sufficient cache memory is available, because typically, an application deletes a temporary file after the handle is closed. In that scenario, the system can entirely avoid writing the data. Otherwise, the data are written after the handle is closed.
FILE_SYS_ATTR_SPARSE_FILE	`0x00000200`	A file that is a sparse file.
FILE_SYS_ATTR_REPARSE_POINT	`0x00000400`	A file that is a reparse point or a symbolic link.
FILE_SYS_ATTR_COMPRESSED	`0x00000800`	A file or directory that is compressed. For a file, all of the data in the file are compressed. For a directory, compression is the default for newly created files and subdirectories. A filesystem implementation can make use of this attribute by setting the support_compressed_attribute property to `True` and then properly handling the on_get_file_info, on_enumerate_directory, and on_set_file_attributes events.
FILE_SYS_ATTR_OFFLINE	`0x00001000`	The data of a file are not available immediately. This attribute indicates that the file data are physically moved to offline storage.
FILE_SYS_ATTR_NOT_CONTENT_INDEXED	`0x00002000`	The file or directory is not to be indexed by the content indexing service.
FILE_SYS_ATTR_ENCRYPTED	`0x00004000`	A file or directory that is encrypted. For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories. Note: This flag is used by NTFS and the OS sends undocumented requests to the filesystem based on this flag. The flag should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_VIRTUAL	`0x00010000`	Reserved. Note: This flag is reserved by the OS and should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_RECALL_ON_OPEN	`0x00040000`	The file or directory has no physical representation on the local system; the item is virtual. Opening the item will be more expensive than normal (e.g., it will cause at least some of it to be fetched from a remote store). This flag is reported by filesystems during directory enumerations.

ShareMode may contain zero or more of the following share mode flags:


FILESYS_SHARE_READ	`0x00000001`	Enables subsequent open operations on a file or device to request read access. Enables subsequent open operations to request read access; otherwise, no process can open the file or device if it requests read access. If this flag is not specified, but the file or device has been opened for read access, the function fails.
FILESYS_SHARE_WRITE	`0x00000002`	Enables subsequent open operations on a file or device to request write access. Enables subsequent open operations to request write access; otherwise, no process can open the file or device if it requests write access. If this flag is not specified, but the file or device has been opened for write access or has a file mapping with write access, the function fails.
FILESYS_SHARE_DELETE	`0x00000004`	Enables subsequent open operations on a file or device to request delete access. Enables subsequent open operations to request delete access; otherwise, no process can open the file or device if it requests delete access. If this flag is not specified, but the file or device has been opened for delete access, the function fails. Note: Delete access allows both delete and rename operations.

CreateDisposition may contain one of the following values:


FILE_DISPOSITION_CREATE_NEW	`0x00000001`	Creates a new file, only if it does not already exist. If the specified file exists, the operation fails with an "already exists" error.
FILE_DISPOSITION_CREATE_ALWAYS	`0x00000002`	Creates a new file, always. If the specified file exists and is writable, the system overwrites the file. If the specified file does not exist and is a valid path, a new file is created.
FILE_DISPOSITION_OPEN_EXISTING	`0x00000003`	Opens a file, only if it exists If the specified file does not exist, opening fails.
FILE_DISPOSITION_OPEN_ALWAYS	`0x00000004`	Opens a file, always. If the specified file exists, the operation succeeds. If the specified file does not exist and is a valid path to a writable location, the a file is created.
FILE_DISPOSITION_TRUNCATE_EXISTING	`0x00000005`	Opens a file and truncates it so that its size is zero bytes, only if it exists. If the specified file does not exist, the operation fails with a "file not found" error.

Please refer to Microsoft's documentation for detailed information about these constants.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

If the Options contains the FILE_FLAG_DELETE_ON_CLOSE flag, the on_after_can_file_be_deleted event will fire after this event.

If the file is opened with extended attributes passed in the request, the on_after_set_ea event will fire after this event.

The CreationStatus parameter indicates whether the file was created or opened and can be one of the following values:


CREATION_STATUS_SUPERSEDED	`0x00000000`	An existing file was superseded by the new file. The previous version of a file may still exist if it had hard links other than the name used in the operation.
CREATION_STATUS_OPENED	`0x00000001`	The file existed before the operation and was opened.
CREATION_STATUS_CREATED	`0x00000002`	The file didn't exist before the operation and was created.
CREATION_STATUS_OVERWRITTEN	`0x00000003`	The file exists, and its contents have been replaced.
CREATION_STATUS_EXISTS	`0x00000004`	The file existed before the operation, and no action was taken.
CREATION_STATUS_DOES_NOT_EXIST	`0x000000055`	The file did not exist before the operation, and no action was taken.

Applications may change this parameter's value if they want a different creation status code to be returned.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_query_ea Event

This event fires after information about extended attributes of a file is retrieved.

Syntax

class CBFilterAfterQueryEaEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def return_single_entry() -> bool: ...

  @property
  def ea_list() -> c_void_p: ...

  @property
  def ea_list_length() -> int: ...

  @property
  def ea_index() -> int: ...

  @property
  def restart_scan() -> bool: ...

  @property
  def length_returned() -> int: ...
  @length_returned.setter
  def length_returned(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_query_ea() -> Callable[[CBFilterAfterQueryEaEventParams], None]: ...
@on_after_query_ea.setter
def on_after_query_ea(event_hook: Callable[[CBFilterAfterQueryEaEventParams], None]) -> None: ...

Remarks

This event fires after information about extended attributes of the file specified by FileName is retrieved using the ZwQueryEaFile or FltQueryEaFile function of the system API. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_QUERY_EA flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Buffer parameter points to a memory buffer that, if the request was successful, contains the requested information. The data in the buffer are formatted as a FILE_FULL_EA_INFORMATION structure; please refer to the Microsoft's documentation for more information. The Length parameter reflects the length of this buffer, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

ReturnSingleEntry specifies that the filesystem had to return only the first entry it has found.

EaList is an optional parameter that points to a caller-supplied memory buffer specifying the extended attributes to be queried. The data in the buffer are formatted as a FILE_GET_EA_INFORMATION structure; please refer to the Microsoft's documentation for more information. The EaListLength parameter reflects the length of this data, in bytes. If the caller of the FltQueryEaFile function did not specify any value, it will contain 0.

EaIndex is an optional parameter that specifies the starting index of the attribute, information about which was requested. This parameter is ignored by the filesystem if EaList points to a nonempty list. If the caller of the FltQueryEaFile function did not specify any value, the parameter will contain -1.

The RestartScan parameter instructs the filesystem to restart enumeration of extended attributes from the first entry. If the parameter is False, retrieval of the extended attributes is resumed by the filesystem after a previous request.

LengthReturned is an optional parameter that contains the size, in bytes, of the information, returned in the Buffer.

A handler may modify the contents of the Buffer given that the size of the modified data does not exceed the length of the buffer. When modifying the data, a handler should update LengthReturned accordingly.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_query_file_info Event

This event fires after information about a file or directory is retrieved.

Syntax

class CBFilterAfterQueryFileInfoEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def file_information_class() -> int: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def valid_bytes() -> int: ...
  @valid_bytes.setter
  def valid_bytes(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_query_file_info() -> Callable[[CBFilterAfterQueryFileInfoEventParams], None]: ...
@on_after_query_file_info.setter
def on_after_query_file_info(event_hook: Callable[[CBFilterAfterQueryFileInfoEventParams], None]) -> None: ...

Remarks

This event fires after information about the file or directory specified by FileName is retrieved. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event typically fires in response to the Windows API's NtQueryInformationFile function.

Applications may use this event to modify the output data before the response is returned to the requestor. Applications that choose to do this must:

copy no more than BufferLength bytes into Buffer; and
update the ValidBytes parameter's value afterward so that it correctly reflects the amount of data in Buffer.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_QUERY_FILE_INFO flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The FileInformationClass parameter indicates what kind of file information was requested. Please refer to the NtQueryInformationFile function's documentation for more information about possible values.

The Buffer parameter points to a memory buffer that, if the request was successful, contains the requested file information. The BufferLength and ValidBytes parameters reflect the capacity of Buffer and the length of the data it contains (respectively), in bytes; ValidBytes may be less than BufferLength. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The format of the data is determined by the specified FileInformationClass; please refer to the NtQueryInformationFile function's documentation for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_read_file Event

This event fires after data are read from a file.

Syntax

class CBFilterAfterReadFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def position() -> int: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def bytes_to_read() -> int: ...

  @property
  def reserved() -> int: ...

  @property
  def direction() -> int: ...

  @property
  def bytes_read() -> int: ...
  @bytes_read.setter
  def bytes_read(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_read_file() -> Callable[[CBFilterAfterReadFileEventParams], None]: ...
@on_after_read_file.setter
def on_after_read_file(event_hook: Callable[[CBFilterAfterReadFileEventParams], None]) -> None: ...

Remarks

This event fires after data are read from the file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications may use this event to modify the data that were read from the file before it is returned to the requestor. Applications that choose to do this must:

enable the ModifiableReadWriteBuffers configuration setting (i.e., before this event fires);
copy no more than BytesToRead bytes into Buffer; and
update the BytesRead parameter's value afterward so that it correctly reflects the amount of data in Buffer.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_READ flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Position parameter reflects the byte offset in the file at which reading started.

The Buffer parameter points to a memory buffer that, if the request was successful, contains the data that were read from the file. The BufferLength parameter reflects the capacity of Buffer, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The BytesToRead parameter reflects how many bytes were to be read from the file (i.e., how many bytes the requestor expects will be read).

The Direction parameter indicates the request direction; please refer to the Cached and Non-Cached Requests topic for more information. Possible values are as follows:


FS_REQUEST_DIR_USER_NONCACHED	`0`	Operations performed in the `user mode application <--> filesystem` direction.
FS_REQUEST_DIR_USER_CACHED	`1`	Operations performed in the `user mode application <--> system cache` direction.
FS_REQUEST_DIR_SYSTEM_NONCACHED	`2`	Operations performed in the `system cache <--> filesystem` direction.
FS_REQUEST_DIR_SYSTEM_CACHED	`3`	Operations performed in the `system component <--> system cache` direction.

The BytesRead parameter specifies how many bytes were actually read from the file, and thus the length of the data in Buffer. This parameter's value must not exceed BufferLength (and should not exceed BytesToRead; please refer to on_before_read_file for more information).

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_rename_or_move_file Event

This event fires after a file or directory is renamed or moved.

Syntax

class CBFilterAfterRenameOrMoveFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def new_file_name() -> str: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_rename_or_move_file() -> Callable[[CBFilterAfterRenameOrMoveFileEventParams], None]: ...
@on_after_rename_or_move_file.setter
def on_after_rename_or_move_file(event_hook: Callable[[CBFilterAfterRenameOrMoveFileEventParams], None]) -> None: ...

Remarks

This event fires after the file or directory specified by FileName is renamed or moved to NewFileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_RENAME flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

A rule's mask is matched against both previous and new file names, and the event will fire when either of the names matches the mask.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_allocation_size Event

This event fires after a file's allocation size is changed.

Syntax

class CBFilterAfterSetAllocationSizeEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def allocation_size() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_allocation_size() -> Callable[[CBFilterAfterSetAllocationSizeEventParams], None]: ...
@on_after_set_allocation_size.setter
def on_after_set_allocation_size(event_hook: Callable[[CBFilterAfterSetAllocationSizeEventParams], None]) -> None: ...

Remarks

This event fires after the allocation size of the file specified by FileName is changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_SIZES flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The AllocationSize parameter reflects the new allocation size, in bytes. A file's allocation size is typically larger than its actual size because filesystem operations often reserve space on disk before writing additional data to a file.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_ea Event

This event fires after extended attributes of a file are changed.

Syntax

class CBFilterAfterSetEaEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_ea() -> Callable[[CBFilterAfterSetEaEventParams], None]: ...
@on_after_set_ea.setter
def on_after_set_ea(event_hook: Callable[[CBFilterAfterSetEaEventParams], None]) -> None: ...

Remarks

This event fires after extended attributes are changed for the file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

If the file is created or opened with extended attributes passed in the request, this event will fire shortly after the on_after_create_file or on_after_open_file event.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_EA flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Buffer parameter points to a memory buffer that specifies the extended attribute information. The Length parameter reflects the length of this buffer, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a FILE_FULL_EA_INFORMATION structure; please refer to the Microsoft's documentation for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_file_attributes Event

This event fires after a file or directory's attributes or times are changed.

Syntax

class CBFilterAfterSetFileAttributesEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def creation_time() -> datetime.datetime: ...

  @property
  def last_access_time() -> datetime.datetime: ...

  @property
  def last_write_time() -> datetime.datetime: ...

  @property
  def change_time() -> datetime.datetime: ...

  @property
  def attributes() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_file_attributes() -> Callable[[CBFilterAfterSetFileAttributesEventParams], None]: ...
@on_after_set_file_attributes.setter
def on_after_set_file_attributes(event_hook: Callable[[CBFilterAfterSetFileAttributesEventParams], None]) -> None: ...

Remarks

This event fires after the attributes or times of the file or directory specified by FileName are changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_ATTRIBUTES flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The CreationTime, LastAccessTime, LastWriteTime, and ChangeTime parameters reflect the new time values, specified in UTC. A value of January 1, 1601 00:00:00 UTC indicates that the corresponding time value was not included in the request.

The Attributes parameter reflects the new attributes; please refer to Microsoft's File Attribute Constants article for attribute descriptions.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_file_info Event

This event fires after information about a file or directory is changed.

Syntax

class CBFilterAfterSetFileInfoEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def file_information_class() -> int: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def valid_bytes() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_file_info() -> Callable[[CBFilterAfterSetFileInfoEventParams], None]: ...
@on_after_set_file_info.setter
def on_after_set_file_info(event_hook: Callable[[CBFilterAfterSetFileInfoEventParams], None]) -> None: ...

Remarks

This event fires after information about the file or directory specified by FileName is changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event typically fires in response to the Windows API's NtSetInformationFile function.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_FILE_INFO flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The FileInformationClass parameter indicates what kind of file information was set. Please refer to the NtSetInformationFile function's documentation for more information about possible values.

The Buffer parameter points to a memory buffer that, if the request was successful, contains the new file information. The BufferLength and ValidBytes parameters reflect the capacity of Buffer and the length of the data it contains (respectively), in bytes; ValidBytes may be less than BufferLength. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The format of the data is determined by the specified FileInformationClass; please refer to the NtSetInformationFile function's documentation for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_file_security Event

This event fires after a file or directory's security attributes are changed.

Syntax

class CBFilterAfterSetFileSecurityEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_file_security() -> Callable[[CBFilterAfterSetFileSecurityEventParams], None]: ...
@on_after_set_file_security.setter
def on_after_set_file_security(event_hook: Callable[[CBFilterAfterSetFileSecurityEventParams], None]) -> None: ...

Remarks

This event fires after security attributes are changed for the file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_SECURITY flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The SecurityInformation parameter reflects which pieces of security information, of those present in SecurityDescriptor, were to be set. Please refer to Microsoft's SECURITY_INFORMATION data-type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that contains the new security information. The Length parameter reflects the length of this data, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_file_size Event

This event fires after a file is resized.

Syntax

class CBFilterAfterSetFileSizeEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def size() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_file_size() -> Callable[[CBFilterAfterSetFileSizeEventParams], None]: ...
@on_after_set_file_size.setter
def on_after_set_file_size(event_hook: Callable[[CBFilterAfterSetFileSizeEventParams], None]) -> None: ...

Remarks

This event fires after the file specified by FileName is resized, whether explicitly (e.g., truncation) or implicitly (i.e., as data are appended). For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_SIZES flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Size parameter reflects the new file size, in bytes.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_set_reparse_point Event

This event fires after the OS creates or updates a reparse point on a file or directory.

Syntax

class CBFilterAfterSetReparsePointEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def reparse_tag() -> int: ...

  @property
  def reparse_buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def data_length() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_set_reparse_point() -> Callable[[CBFilterAfterSetReparsePointEventParams], None]: ...
@on_after_set_reparse_point.setter
def on_after_set_reparse_point(event_hook: Callable[[CBFilterAfterSetReparsePointEventParams], None]) -> None: ...

Remarks

This event fires after the OS creates or updates a reparse point on a file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_SET_REPARSE_POINT flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The ReparseTag parameter contains the reparse tag, which is the value the system uses to identify the format of the reparse point data. This value is also present in the ReparseBuffer data; the class extracts it and provides it separately for convenience.

The ReparseBuffer parameter points to a memory buffer that specifies the new reparse point information. The DataLength parameter reflects the length of the data contained in the buffer, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

Please refer to the Reparse Points topic for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_unlock_all Event

This event fires after all locked byte ranges in a file are unlocked.

Syntax

class CBFilterAfterUnlockAllEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_unlock_all() -> Callable[[CBFilterAfterUnlockAllEventParams], None]: ...
@on_after_unlock_all.setter
def on_after_unlock_all(event_hook: Callable[[CBFilterAfterUnlockAllEventParams], None]) -> None: ...

Remarks

This event fires after all locked byte ranges in the file specified by FileName are unlocked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_LOCK_CONTROL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_unlock_all_by_key Event

This event fires after all locked byte ranges in a file, associated with a particular key, are unlocked.

Syntax

class CBFilterAfterUnlockAllByKeyEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def key() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_unlock_all_by_key() -> Callable[[CBFilterAfterUnlockAllByKeyEventParams], None]: ...
@on_after_unlock_all_by_key.setter
def on_after_unlock_all_by_key(event_hook: Callable[[CBFilterAfterUnlockAllByKeyEventParams], None]) -> None: ...

Remarks

This event fires after all locked byte ranges in the file specified by FileName, and associated with the specified Key, are unlocked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_LOCK_CONTROL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Key parameter contains the key value specified when the byte ranges were locked. Please refer to the on_after_lock event's documentation for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_unlock_single Event

This event fires after a particular locked byte range in a file is unlocked.

Syntax

class CBFilterAfterUnlockSingleEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def offset() -> int: ...

  @property
  def length() -> int: ...

  @property
  def key() -> int: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_unlock_single() -> Callable[[CBFilterAfterUnlockSingleEventParams], None]: ...
@on_after_unlock_single.setter
def on_after_unlock_single(event_hook: Callable[[CBFilterAfterUnlockSingleEventParams], None]) -> None: ...

Remarks

This event fires after a particular locked byte range in the file specified by FileName is unlocked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_LOCK_CONTROL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Offset, Length, and Key parameters contain the starting byte offset, length, and key values (respectively) specified when the byte range was locked. Please refer to the on_after_lock event's documentation for more information.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_after_write_file Event

This event fires after data are written to a file.

Syntax

class CBFilterAfterWriteFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def position() -> int: ...

  @property
  def buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @property
  def bytes_to_write() -> int: ...

  @property
  def direction() -> int: ...

  @property
  def bytes_written() -> int: ...
  @bytes_written.setter
  def bytes_written(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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 event_context() -> int: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_after_write_file() -> Callable[[CBFilterAfterWriteFileEventParams], None]: ...
@on_after_write_file.setter
def on_after_write_file(event_hook: Callable[[CBFilterAfterWriteFileEventParams], None]) -> None: ...

Remarks

This event fires after data are written to the file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications may use this event to inspect the data that were written to the file, but must not attempt to alter said data. If, during on_before_write_file, an application causes less data than requested to be written to the file, it should use this event to set BytesWritten back to the expected value (i.e., BytesToWrite) to prevent the requestor from behaving unexpectedly.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_AFTER_WRITE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Position parameter reflects the byte offset in the file at which writing started. A value of -1 means "append to the end of the file".

The Buffer parameter points to a memory buffer that contains the data that, if the request was successful, were written to the file. The BufferLength parameter reflects the capacity of Buffer, in bytes. Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The BytesToWrite parameter reflects how many bytes were to be written to the file (i.e., how many bytes the requestor expects will be written).

The Direction parameter indicates the request direction; please refer to the Cached and Non-Cached Requests topic for more information. Possible values are as follows:


FS_REQUEST_DIR_USER_NONCACHED	`0`	Operations performed in the `user mode application <--> filesystem` direction.
FS_REQUEST_DIR_USER_CACHED	`1`	Operations performed in the `user mode application <--> system cache` direction.
FS_REQUEST_DIR_SYSTEM_NONCACHED	`2`	Operations performed in the `system cache <--> filesystem` direction.
FS_REQUEST_DIR_SYSTEM_CACHED	`3`	Operations performed in the `system component <--> system cache` direction.

The BytesWritten parameter specifies how many bytes were actually written to the file. This parameter's value must not exceed BufferLength (and should not exceed BytesToWrite; please refer to on_before_write_file for more information).

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_can_file_be_deleted Event

This event fires before the OS attempts to mark a file or directory for deletion or remove such a mark.

Syntax

class CBFilterBeforeCanFileBeDeletedEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def request_type() -> int: ...

  @property
  def can_delete() -> bool: ...
  @can_delete.setter
  def can_delete(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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_can_file_be_deleted() -> Callable[[CBFilterBeforeCanFileBeDeletedEventParams], None]: ...
@on_before_can_file_be_deleted.setter
def on_before_can_file_be_deleted(event_hook: Callable[[CBFilterBeforeCanFileBeDeletedEventParams], None]) -> None: ...

Remarks

This event fires before the OS marks the file or directory specified by FileName for deletion or removes such a mark. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

If the file or directory is created or opened with the FILE_FLAG_DELETE_ON_CLOSE flag, this event is fired shortly before the on_before_create_file or on_before_open_file event.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_CAN_DELETE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The RequestType indicates which kind of system request resulted in firing this event. It can be one of the following:


DEL_REQ_OPEN_FLAG	`0x1`	The file or directory is opened with the FILE_FLAG_DELETE_ON_CLOSE flag
DEL_REQ_SET_DISPOSITION	`0x2`	The system has sent the IRP_MJ_SET_INFORMATION request with SetFileDisposition structure as a parameter. This request usually is sent using the `NtSetInformationFile()` Windows native API function.

The CanDelete parameter specifies whether the file or directory will be deleted. This parameter can be True or False depending on which request the OS has sent. Applications may prevent deletion of the file or directory by setting CanDelete to False. Changing CanDelete from False to True may or may not have the effect on the file being deleted later, so such a change should be avoided.

Note: If the file is opened with FILE_FLAG_DELETE_ON_CLOSE flag set and the event handler permits file deletion, such flag cannot be removed later (even with the call to NtSetInformationFile() API function).

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

The effect of ProcessRequest depends on what operation caused the event to fire:

If the event fires during the file open operation where the FILE_FLAG_DELETE_ON_CLOSE flag is set,
- setting CanDelete to False and ProcessRequest to True causes the FILE_FLAG_DELETE_ON_CLOSE flag to be removed and the file open request to be passed further to the filesystem; and
- setting CanDelete to False and ProcessRequest to False causes the file open request to fail with ACCESS_DENIED error.
If the event fires in the context of the call to NtSetInformationFile Windows API function, setting CanDelete to False causes the DeleteFlag parameter to be set to False and the request to be passed further to the filesystem. This combination effectively resets the file deletion state, known to the filesystem, to the False ("do not delete") value. The value of ProcessRequest in this case does not matter as the new value must reach the filesystem.

When ProcessRequest to False (which means that the request was handled), the handler may additionally specify the status of the handling by setting the Status parameter to the required NT status code (this is not a Win32 error code!).

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_cleanup_file Event

This event fires before a file or directory handle is closed.

Syntax

class CBFilterBeforeCleanupFileEventParams(object):
  @property
  def file_name() -> str: ...

  @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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_before_cleanup_file() -> Callable[[CBFilterBeforeCleanupFileEventParams], None]: ...
@on_before_cleanup_file.setter
def on_before_cleanup_file(event_hook: Callable[[CBFilterBeforeCleanupFileEventParams], None]) -> None: ...

Remarks

This event fires before a handle to the file or directory specified by FileName is closed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event differs from on_before_close_file in that on_before_cleanup_file fires immediately before an open handle to the specified file or directory is closed by a process, whereas on_before_close_file may be fired much later when the OS itself decides that the file or directory can be formally closed.

Other events may fire for the file or directory in the time between when this event fires and when the on_before_close_file event fires. For example, system components such as the memory manager or cache manager may cause the on_before_read_file and on_before_write_file events to fire.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_CLEANUP flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_close_file Event

This event fires before a file or directory is closed.

Syntax

class CBFilterBeforeCloseFileEventParams(object):
  @property
  def file_name() -> str: ...

  @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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_before_close_file() -> Callable[[CBFilterBeforeCloseFileEventParams], None]: ...
@on_before_close_file.setter
def on_before_close_file(event_hook: Callable[[CBFilterBeforeCloseFileEventParams], None]) -> None: ...

Remarks

This event fires before the file or directory specified by FileName is closed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_CLOSE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

If the file or directory was marked for deletion earlier, the on_before_delete_file will fire shortly before this event.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_create_file Event

This event fires before a file or directory is created.

Syntax

class CBFilterBeforeCreateFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def existing_attributes() -> int: ...

  @property
  def isolate() -> bool: ...
  @isolate.setter
  def isolate(value) -> None: ...

  @property
  def backend_file_name() -> str: ...
  @backend_file_name.setter
  def backend_file_name(value) -> None: ...

  @property
  def desired_access() -> int: ...
  @desired_access.setter
  def desired_access(value) -> None: ...

  @property
  def attributes() -> int: ...
  @attributes.setter
  def attributes(value) -> None: ...

  @property
  def share_mode() -> int: ...
  @share_mode.setter
  def share_mode(value) -> None: ...

  @property
  def options() -> int: ...
  @options.setter
  def options(value) -> None: ...

  @property
  def create_disposition() -> int: ...
  @create_disposition.setter
  def create_disposition(value) -> None: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_file() -> Callable[[CBFilterBeforeCreateFileEventParams], None]: ...
@on_before_create_file.setter
def on_before_create_file(event_hook: Callable[[CBFilterBeforeCreateFileEventParams], None]) -> None: ...

Remarks

This event fires before the file or directory specified by FileName is created. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. Please refer to the File Create/Open Events topic for more information about how the class determines whether to fire this event or on_before_open_file.

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; and set Status to the desired NT status (the parameter is set to STATUS_ACCESS_DENIED before the event is fired).

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_CREATE flag.

Note: Applications must have the FilterOwnRequests configuration setting enabled if they wish to filter their own file/directory creation requests.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

To redirect file access to another location, or to provide custom file content, set Isolate to True. For instance if Process A and Process B both access a file, isolation allows returning different content to each process. When Isolate is set to True the BackendFileName parameter determines if the file is redirected, and to where.


BackendFileName Value	Description
`FileName`	By default `BackendFileName` is set to the same value as `FileName` and requests are directed to the original file.
Custom Path	Set `BackendFileName` to the full path of another file on disk to redirect requests to a different file.
`""` (empty string)	When set to an empty string, file-related events must be handled to provide all information and content for the file. This mode is useful for providing modified content on-the-fly, such as returning decrypted content for specific processes.

When requests are redirected to an existing file on disk a dedicated cache is created for the isolated file by the CBFilter driver. This cache ensures that the data it holds do not interfere with the data read from or written to the file when it is opened without isolation. Please see the File Isolation topic for further details.

To ensure that isolation works properly, on Windows 11, the on_bypass_io_request event is fired when the OS makes a request to enable BypassIO on this file, giving a way for the application to forbid BypassIO with an application-specific error code and explanation.

Requests may also be redirected to another file or directory via the on_reparse_file_name event which is fired before this event. In order for the on_reparse_file_name event to fire, a standard filter rule must exist that includes the FS_CE_REPARSE_FILENAME flag. For more details, please see the on_reparse_file_name topic.

The initial values of DesiredAccess, Attributes, ShareMode, and CreateDisposition parameters reflect the values that were passed for the similarly named parameters of the Windows API's CreateFile function (or, more accurately, the values carried by the IRP_MJ_CREATE Internet Relay Programming).

DesiredAccess may contain one or more of the following access flags:


DESIRED_ACCESS_FILE_LIST_DIRECTORY	`0x00000001`	For a directory, the right to list the contents of the directory.
DESIRED_ACCESS_FILE_READ_DATA	`0x00000001`	For a file object, the right to read the corresponding file data. For a directory object, the right to read the corresponding directory data.
DESIRED_ACCESS_FILE_ADD_FILE	`0x00000002`	For a directory, the right to create a file in the directory.
DESIRED_ACCESS_FILE_WRITE_DATA	`0x00000002`	For a file object, the right to write data to the file. For a directory object, the right to create a file in the directory
DESIRED_ACCESS_FILE_ADD_SUBDIRECTORY	`0x00000004`	For a directory, the right to create a subdirectory.
DESIRED_ACCESS_FILE_APPEND_DATA	`0x00000004`	For a file object, the right to append data to the file. (For local files, write operations will not overwrite existing data if this flag is specified without FILE_WRITE_DATA.) For a directory object, the right to create a subdirectory (FILE_ADD_SUBDIRECTORY).
DESIRED_ACCESS_FILE_READ_EA	`0x00000008`	The right to read extended file attributes.
DESIRED_ACCESS_FILE_WRITE_EA	`0x00000010`	The right to write extended file attributes.
DESIRED_ACCESS_FILE_EXECUTE	`0x00000020`	For a native code file, the right to execute the file. This access right given to scripts may cause the script to be executable, depending on the script interpreter.
DESIRED_ACCESS_FILE_DELETE_CHILD	`0x00000040`	For a directory, the right to delete a directory and all the files it contains, including read-only files.
DESIRED_ACCESS_FILE_READ_ATTRIBUTES	`0x00000080`	The right to read file attributes.
DESIRED_ACCESS_FILE_WRITE_ATTRIBUTES	`0x00000100`	The right to write file attributes.
DESIRED_ACCESS_READ_CONTROL	`0x00020000`	The right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_READ	`0x00020000`	Includes READ_CONTROL, which is the right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_WRITE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_STANDARD_RIGHTS_EXECUTE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_SYNCHRONIZE	`0x00100000`	The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.
DESIRED_ACCESS_FILE_ALL_ACCESS	`0x001F01FF`	All possible access rights for a file.
DESIRED_ACCESS_FILE_GENERIC_READ	`0x00120089`	A combinarion of flags that allow reading of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_WRITE	`0x00120116`	A combinarion of flags that allow modifications to the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_EXECUTE	`0x001200A0`	A combinarion of flags that allow execution of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Attributes may contain one or more of the following attributes:


FILE_SYS_ATTR_READ_ONLY	`0x00000001`	The file is read-only. Applications can read the file, but cannot write to it or delete it. This attribute is not honored on directories.
FILE_SYS_ATTR_HIDDEN	`0x00000002`	The file or directory is hidden. The file is not included in an ordinary directory listing.
FILE_SYS_ATTR_SYSTEM	`0x00000004`	A file or directory that the operating system uses a part of, or uses exclusively.
FILE_SYS_ATTR_DIRECTORY	`0x00000010`	The entry is a directory.
FILE_SYS_ATTR_ARCHIVE	`0x00000020`	The entry is an archive file or directory. Applications typically use this attribute to mark files for backup or removal.
FILE_SYS_ATTR_NORMAL	`0x00000080`	A file doesn't have other attributes set. This attribute is valid only when used alone.
FILE_SYS_ATTR_TEMPORARY	`0x00000100`	A file that is being used for temporary storage. File systems avoid writing data back to mass storage if sufficient cache memory is available, because typically, an application deletes a temporary file after the handle is closed. In that scenario, the system can entirely avoid writing the data. Otherwise, the data are written after the handle is closed.
FILE_SYS_ATTR_SPARSE_FILE	`0x00000200`	A file that is a sparse file.
FILE_SYS_ATTR_REPARSE_POINT	`0x00000400`	A file that is a reparse point or a symbolic link.
FILE_SYS_ATTR_COMPRESSED	`0x00000800`	A file or directory that is compressed. For a file, all of the data in the file are compressed. For a directory, compression is the default for newly created files and subdirectories. A filesystem implementation can make use of this attribute by setting the support_compressed_attribute property to `True` and then properly handling the on_get_file_info, on_enumerate_directory, and on_set_file_attributes events.
FILE_SYS_ATTR_OFFLINE	`0x00001000`	The data of a file are not available immediately. This attribute indicates that the file data are physically moved to offline storage.
FILE_SYS_ATTR_NOT_CONTENT_INDEXED	`0x00002000`	The file or directory is not to be indexed by the content indexing service.
FILE_SYS_ATTR_ENCRYPTED	`0x00004000`	A file or directory that is encrypted. For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories. Note: This flag is used by NTFS and the OS sends undocumented requests to the filesystem based on this flag. The flag should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_VIRTUAL	`0x00010000`	Reserved. Note: This flag is reserved by the OS and should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_RECALL_ON_OPEN	`0x00040000`	The file or directory has no physical representation on the local system; the item is virtual. Opening the item will be more expensive than normal (e.g., it will cause at least some of it to be fetched from a remote store). This flag is reported by filesystems during directory enumerations.

ShareMode may contain zero or more of the following share mode flags:


FILESYS_SHARE_READ	`0x00000001`	Enables subsequent open operations on a file or device to request read access. Enables subsequent open operations to request read access; otherwise, no process can open the file or device if it requests read access. If this flag is not specified, but the file or device has been opened for read access, the function fails.
FILESYS_SHARE_WRITE	`0x00000002`	Enables subsequent open operations on a file or device to request write access. Enables subsequent open operations to request write access; otherwise, no process can open the file or device if it requests write access. If this flag is not specified, but the file or device has been opened for write access or has a file mapping with write access, the function fails.
FILESYS_SHARE_DELETE	`0x00000004`	Enables subsequent open operations on a file or device to request delete access. Enables subsequent open operations to request delete access; otherwise, no process can open the file or device if it requests delete access. If this flag is not specified, but the file or device has been opened for delete access, the function fails. Note: Delete access allows both delete and rename operations.

When the file being created or opened is virtual, the event handler must inspect and handle the value of the ShareMode parameter as a filesystem would normally do it.

CreateDisposition may contain one of the following values:


FILE_DISPOSITION_CREATE_NEW	`0x00000001`	Creates a new file, only if it does not already exist. If the specified file exists, the operation fails with an "already exists" error.
FILE_DISPOSITION_CREATE_ALWAYS	`0x00000002`	Creates a new file, always. If the specified file exists and is writable, the system overwrites the file. If the specified file does not exist and is a valid path, a new file is created.
FILE_DISPOSITION_OPEN_EXISTING	`0x00000003`	Opens a file, only if it exists If the specified file does not exist, opening fails.
FILE_DISPOSITION_OPEN_ALWAYS	`0x00000004`	Opens a file, always. If the specified file exists, the operation succeeds. If the specified file does not exist and is a valid path to a writable location, the a file is created.
FILE_DISPOSITION_TRUNCATE_EXISTING	`0x00000005`	Opens a file and truncates it so that its size is zero bytes, only if it exists. If the specified file does not exist, the operation fails with a "file not found" error.

When the file being created or opened is virtual, the event handler must inspect and handle the value of the CreateDisposition parameter as a filesystem would normally do it. This includes adjusting the file size and updating the time attributes depending on the flag. For a virtual file, the driver returns the CreationStatus value that is derived from CreateDisposition as follows:


FILE_DISPOSITION_CREATE_NEW	=>	CREATION_STATUS_CREATED
FILE_DISPOSITION_CREATE_ALWAYS	=>	CREATION_STATUS_OVERWRITTEN
FILE_DISPOSITION_OPEN_EXISTING	=>	CREATION_STATUS_OPENED
FILE_DISPOSITION_OPEN_ALWAYS	=>	CREATION_STATUS_OPENED
FILE_DISPOSITION_TRUNCATE_EXISTING	=>	CREATION_STATUS_OVERWRITTEN

If the event handler needs to change the returned CreationStatus, it should change the value of the CreateDisposition to the FILE_DISPOSITION_*** value that leads to the desired CreationStatus value (e.g. set the value to FILE_DISPOSITION_OPEN_EXISTING so that the driver returns CREATION_STATUS_OPENED).

Options contains the flags that are described in the CreateOptions parameter of the Native API's ZwCreateFile function. Most of those flags correspond to flags passed in the FlagsAndAttributes parameter of the Windows API's CreateFile function, but some flags are specific to Native API. If you need those flags, check both functions' descriptions.

Please refer to Microsoft's documentation for detailed information about these constants.

To determine whether the request is for a file or a directory, compare Attributes against the FILE_SYS_ATTR_DIRECTORY constant, as follows: // Check whether the request is for a file or a directory. bool isDirectory = Attributes & FILE_SYS_ATTR_DIRECTORY == FILE_SYS_ATTR_DIRECTORY; FILE_SYS_ATTR_DIRECTORY will be present only if it was specified by the calling process; its presence or absence does not indicate the real presence of the attribute on the file or directory on disk.

Note: Files can be deleted in different ways, so do not use this check to take actions related to tracking file deletion operations. Instead, use the events related to file deletion.

To prevent a file or directory from being opened, set the ResultCode parameter to a non-zero value (typically ERROR_ACCESS_DENIED (5)).

The data are formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

If an application needs to alter the security information, it can do this by placing up to Length bytes of information into the SecurityDescriptor buffer.

Note: Changing the security data is possible only when the PassSecurityInFileOpenEvents configuration setting is enabled.

If the capacity reflected by the Length parameter is not enough to accommodate the security information, set LengthNeeded to the number of bytes necessary to hold the data, and return the ERROR_INSUFFICIENT_BUFFER error code via ResultCode.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

If the Options contains the FILE_FLAG_DELETE_ON_CLOSE flag, the on_before_can_file_be_deleted event will fire before this event.

If the file is opened with extended attributes passed in the request, the on_before_set_ea event will fire after this event.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_create_hard_link Event

This 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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. 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 need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_CREATE_HARD_LINK flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

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 ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_delete_file Event

This event fires before a file or directory is deleted.

Syntax

class CBFilterBeforeDeleteFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def request_type() -> int: ...

  @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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_before_delete_file() -> Callable[[CBFilterBeforeDeleteFileEventParams], None]: ...
@on_before_delete_file.setter
def on_before_delete_file(event_hook: Callable[[CBFilterBeforeDeleteFileEventParams], None]) -> None: ...

Remarks

This event fires before the file or directory specified by FileName is deleted. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. More specifically, this event is fired before the final IRM_MJ_CLOSE Internet Relay Programming (IRP) is processed by the filesystem and before on_before_close_file fires.

Applications may use this event to obtain information about the specified file or directory, which still exists at the time this event fires. This event cannot be used to prevent a deletion; use the on_before_can_file_be_deleted event instead.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_DELETE flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The RequestType indicates which kind of system request resulted in firing this event. It can be one of the following:


DEL_REQ_OPEN_FLAG	`0x1`	The file or directory is opened with the FILE_FLAG_DELETE_ON_CLOSE flag
DEL_REQ_SET_DISPOSITION	`0x2`	The system has sent the IRP_MJ_SET_INFORMATION request with SetFileDisposition structure as a parameter. This request usually is sent using the `NtSetInformationFile()` Windows native API function.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_delete_reparse_point Event

This event fires when the OS wants to delete a reparse point from a file or directory.

Syntax

class CBFilterBeforeDeleteReparsePointEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def reparse_buffer() -> c_void_p: ...

  @property
  def buffer_length() -> int: ...

  @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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_delete_reparse_point() -> Callable[[CBFilterBeforeDeleteReparsePointEventParams], None]: ...
@on_before_delete_reparse_point.setter
def on_before_delete_reparse_point(event_hook: Callable[[CBFilterBeforeDeleteReparsePointEventParams], None]) -> None: ...

Remarks

This event fires before the OS deletes a reparse point from a file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Note: The file or directory is not deleted, only the reparse point is.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_DELETE_REPARSE_POINT flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

Please refer to the Reparse Points topic for more information.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_enumerate_directory Event

This event fires when an enumeration request is sent by the OS.

Syntax

class CBFilterBeforeEnumerateDirectoryEventParams(object):
  @property
  def directory_name() -> str: ...

  @property
  def flags() -> int: ...

  @property
  def mask() -> str: ...

  @property
  def index() -> int: ...

  @property
  def directory_context() -> int: ...
  @directory_context.setter
  def directory_context(value) -> None: ...

  @property
  def handle_context() -> int: ...
  @handle_context.setter
  def handle_context(value) -> None: ...

  @property
  def enumeration_context() -> int: ...
  @enumeration_context.setter
  def enumeration_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_enumerate_directory() -> Callable[[CBFilterBeforeEnumerateDirectoryEventParams], None]: ...
@on_before_enumerate_directory.setter
def on_before_enumerate_directory(event_hook: Callable[[CBFilterBeforeEnumerateDirectoryEventParams], None]) -> None: ...

Remarks

This event fires when the OS sends a request for reading one or more entries of the directory specified by DirectoryName. For more information about the DirectoryName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications may use this event to record the request and optionally block it.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_ENUMERATE_DIRECTORY flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Flags parameter specifies supplementary information about enumeration. It is a combination of zero or more values:


FS_ENUM_RESTART_SCAN	`1`	The requestor specified that directory enumeration must be restarted.
FS_ENUM_RETURN_SINGLE_ENTRY	`2`	One entry should be returned.
FS_ENUM_INDEX_SPECIFIED	`4`	The requestor specified the index to start enumeration from.

If the Flags parameter contains FS_ENUM_INDEX_SPECIFIED, the Index parameter contains the index as provided by the OS.

The Mask parameter contains the mask for the enumeration. This value may contain any combination of valid file name characters and wildcards (the * and ? characters). Alternatively, it may be an exact file name (i.e., a value without any wildcards), as some applications query file information by specifying an exact file name in an enumeration. When TranslateDOSCharsInEnumMasks is False, this parameter may contain a so-called DOS wildcard (please, refer to the description of this setting for more information). The mask can also be empty in rare cases: this happens when the OS request is a continuation of a previous enumeration with a valid non-zero Index.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_filter_attach_to_volume Event

This event fires before the filter attaches to a newly mounted filesystem volume.

Syntax

class CBFilterBeforeFilterAttachToVolumeEventParams(object):
  @property
  def volume_name() -> str: ...

  @property
  def volume_name_nt() -> str: ...

  @property
  def skip_volume() -> bool: ...
  @skip_volume.setter
  def skip_volume(value) -> None: ...

  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBFilter:
@property
def on_before_filter_attach_to_volume() -> Callable[[CBFilterBeforeFilterAttachToVolumeEventParams], None]: ...
@on_before_filter_attach_to_volume.setter
def on_before_filter_attach_to_volume(event_hook: Callable[[CBFilterBeforeFilterAttachToVolumeEventParams], None]) -> None: ...

Remarks

This event fires before the filter attaches to the newly mounted filesystem volume specified by VolumeNameNT and, when possible, VolumeName. Please refer to the fire_volume_events property for more information.

Applications need to handle this event only if the fire_volume_events property includes the FS_MOUNT_CONTROL flag.

Applications can obtain additional information about a volume by retrieving its GUID using the get_volume_guid method, and then using that GUID to call various Windows API functions.

The SkipVolume parameter specifies whether the class's system driver should skip the specified volume (i.e., not attach the filter to it). Setting this parameter to True will cause all filesystem operations that target to volume to be completely ignored by the class's system driver. It also will prevent any of the following events from firing for the volume:

on_after_filter_attach_to_volume
on_notify_filter_attach_to_volume
on_after_filter_detach_from_volume
on_notify_filter_detach_from_volume

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_fsctl Event

This event fires before an IRP_MJ_FILE_SYSTEM_CONTROL request is processed.

Syntax

class CBFilterBeforeFsctlEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def fs_control_code() -> int: ...

  @property
  def in_buffer() -> c_void_p: ...

  @property
  def in_buffer_length() -> int: ...

  @property
  def in_buffer_valid_bytes() -> int: ...
  @in_buffer_valid_bytes.setter
  def in_buffer_valid_bytes(value) -> None: ...

  @property
  def out_buffer() -> c_void_p: ...

  @property
  def out_buffer_length() -> int: ...

  @property
  def out_buffer_valid_bytes() -> int: ...
  @out_buffer_valid_bytes.setter
  def out_buffer_valid_bytes(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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_fsctl() -> Callable[[CBFilterBeforeFsctlEventParams], None]: ...
@on_before_fsctl.setter
def on_before_fsctl(event_hook: Callable[[CBFilterBeforeFsctlEventParams], None]) -> None: ...

Remarks

This event fires before an IRP_MJ_FILE_SYSTEM_CONTROL (FSCTL) request is processed. Such requests are sent using the Windows API's DeviceIoControl function (user mode), or ZwFsControlFile function (kernel mode); please refer to Microsoft's documentation for more information.

Applications may use this event to modify the input data (if there are any) before the request continues onward. Applications that choose to do this must do the following:

Copy no more than InBufferLength bytes into InBuffer.
Update the InBufferValidBytes parameter's value afterward so that it correctly reflects the amount of data in InBuffer.

Alternatively, applications may use this event to handle the request (preventing it from continuing onward), in which case they must do the following:

Copy no more than OutBufferLength bytes into OutBuffer.
Update the OutBufferValidBytes parameter's value afterward so that it correctly reflects the amount of data in OutBuffer.
Set ProcessRequest to False to indicate that the request has been handled and should not continue onward.

(The first two steps are not applicable if the requested operation is not expected to return data.)

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_FSCTL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The FileName parameter reflects the file, directory, or volume targeted by the request.

The FsControlCode parameter reflects the requested filesystem control code (FSCTL).

The OutBuffer parameter points to a memory buffer that receives the data returned by the operation. The OutBufferLength and OutBufferValidBytes parameters reflect the capacity of OutBuffer and the length of the data it contains (respectively), in bytes; OutBufferValidBytes may be less than OutBufferLength (unless the operation is not expected to return data, in which case both will be 0).

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_get_file_security Event

This event fires before a file or directory's security attributes are retrieved.

Syntax

class CBFilterBeforeGetFileSecurityEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def security_information() -> int: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @property
  def length_needed() -> int: ...
  @length_needed.setter
  def length_needed(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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_get_file_security() -> Callable[[CBFilterBeforeGetFileSecurityEventParams], None]: ...
@on_before_get_file_security.setter
def on_before_get_file_security(event_hook: Callable[[CBFilterBeforeGetFileSecurityEventParams], None]) -> None: ...

Remarks

This event fires before security attributes are retrieved for the file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_GET_SECURITY flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The SecurityInformation parameter indicates which pieces of security information are requested. Please refer to Microsoft's SECURITY_INFORMATION data-type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that receives the requested security information. The buffer referenced by the SecurityDescriptor parameter may be modified by the event handler if the operation is completed without passing it further to other filters and the filesystem driver. The Length parameter reflects the capacity of the SecurityDescriptor buffer, in bytes.

If the capacity reflected by the Length parameter is not sufficient to accommodate the security information, set LengthNeeded to the number of bytes necessary to hold the data, and return the ERROR_INSUFFICIENT_BUFFER error code via ResultCode.

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The returned data will be formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_get_reparse_point Event

This event fires when the OS wants to read a reparse point for a file or directory.

Syntax

class CBFilterBeforeGetReparsePointEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def reparse_buffer() -> c_void_p: ...

  @property
  def reparse_buffer_length() -> int: ...
  @reparse_buffer_length.setter
  def reparse_buffer_length(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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_get_reparse_point() -> Callable[[CBFilterBeforeGetReparsePointEventParams], None]: ...
@on_before_get_reparse_point.setter
def on_before_get_reparse_point(event_hook: Callable[[CBFilterBeforeGetReparsePointEventParams], None]) -> None: ...

Remarks

This event fires when the OS wants to read a reparse point for the file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_GET_REPARSE_POINT flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

If an application desires to handle the event and does not pass the request further, it needs to fill ReparseBuffer with the reparse point data associated with the specified file or directory and set ReparseBufferLength to the number of bytes written. The ReparseBufferLength parameter's initial value reflects the capacity of the memory buffer pointed to by ReparseBuffer. If the buffer is too small to hold all of the reparse point data, then the application should write as much data to it as possible, set ReparseBufferLength appropriately, and return the ERROR_MORE_DATA error code via ResultCode.

Please refer to the Reparse Points topic for more information.

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_ioctl Event

This event fires before an IRP_MJ_DEVICE_CONTROL request is processed.

Syntax

class CBFilterBeforeIoctlEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def io_control_code() -> int: ...

  @property
  def in_buffer() -> c_void_p: ...

  @property
  def in_buffer_length() -> int: ...

  @property
  def in_buffer_valid_bytes() -> int: ...
  @in_buffer_valid_bytes.setter
  def in_buffer_valid_bytes(value) -> None: ...

  @property
  def out_buffer() -> c_void_p: ...

  @property
  def out_buffer_length() -> int: ...

  @property
  def out_buffer_valid_bytes() -> int: ...
  @out_buffer_valid_bytes.setter
  def out_buffer_valid_bytes(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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_ioctl() -> Callable[[CBFilterBeforeIoctlEventParams], None]: ...
@on_before_ioctl.setter
def on_before_ioctl(event_hook: Callable[[CBFilterBeforeIoctlEventParams], None]) -> None: ...

Remarks

This event fires before an IRP_MJ_DEVICE_CONTROL (IOCTL) request is processed. Such requests are sent using the Windows API's DeviceIoControl function (user mode), or ZwDeviceIoControlFile function (kernel mode). Please refer to Microsoft's documentation for more information.

Applications may use this event to modify the input data (if there are any) before the request continues onward. Applications that choose to do this must do the following:

Copy no more than InBufferLength bytes into InBuffer.
Update the InBufferValidBytes parameter's value afterward so that it correctly reflects the amount of data in InBuffer.

Alternatively, applications may use this event to handle the request (preventing it from continuing onward), in which case they must do the following:

Copy no more than OutBufferLength bytes into OutBuffer.
Update the OutBufferValidBytes parameter's value afterward so that it correctly reflects the amount of data in OutBuffer.
Set ProcessRequest to False to indicate that the request has been handled and should not continue onward.

(The first two steps are not applicable if the requested operation is not expected to return data.)

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_IOCTL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The FileName parameter reflects the file, directory, or volume targeted by the request.

The IoControlCode parameter reflects the requested I/O control code (IOCTL).

Please see the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_lock Event

This event fires before a range of bytes in a file is locked.

Syntax

class CBFilterBeforeLockEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def offset() -> int: ...
  @offset.setter
  def offset(value) -> None: ...

  @property
  def length() -> int: ...
  @length.setter
  def length(value) -> None: ...

  @property
  def key() -> int: ...

  @property
  def fail_immediately() -> bool: ...
  @fail_immediately.setter
  def fail_immediately(value) -> None: ...

  @property
  def exclusive_lock() -> bool: ...
  @exclusive_lock.setter
  def exclusive_lock(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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_lock() -> Callable[[CBFilterBeforeLockEventParams], None]: ...
@on_before_lock.setter
def on_before_lock(event_hook: Callable[[CBFilterBeforeLockEventParams], None]) -> None: ...

Remarks

This event fires before a range of bytes in the file specified by FileName is locked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This request is made either by the OS, or on behalf of a user mode application that called the Windows API's LockFile or LockFileEx function.

Applications may use this event to modify the request's parameters.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_LOCK_CONTROL flag.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.

The Offset parameter specifies the byte offset where the byte range lock should start.

The Length parameter specifies the length of the byte range lock.

The Key parameter reflects the key that the byte range lock will be associated with. This key is used to identify the byte range lock in later unlock-by-key requests.

The FailImmediately parameter specifies whether the request should fail if the lock cannot be granted immediately.

The ExclusiveLock parameter specifies whether the byte range lock should be exclusive (True) or shared (False).

The ProcessRequest parameter controls whether the request is sent onward for further processing by subsequent filter drivers and the filesystem; it is True by default.

This event is fired synchronously; please refer to the Event Types topic for more information.

on_before_open_file Event

This event fires before a file or directory is opened.

Syntax

class CBFilterBeforeOpenFileEventParams(object):
  @property
  def file_name() -> str: ...

  @property
  def existing_attributes() -> int: ...

  @property
  def isolate() -> bool: ...
  @isolate.setter
  def isolate(value) -> None: ...

  @property
  def backend_file_name() -> str: ...
  @backend_file_name.setter
  def backend_file_name(value) -> None: ...

  @property
  def desired_access() -> int: ...
  @desired_access.setter
  def desired_access(value) -> None: ...

  @property
  def attributes() -> int: ...
  @attributes.setter
  def attributes(value) -> None: ...

  @property
  def share_mode() -> int: ...
  @share_mode.setter
  def share_mode(value) -> None: ...

  @property
  def options() -> int: ...
  @options.setter
  def options(value) -> None: ...

  @property
  def create_disposition() -> int: ...
  @create_disposition.setter
  def create_disposition(value) -> None: ...

  @property
  def security_descriptor() -> c_void_p: ...

  @property
  def length() -> int: ...

  @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 event_context() -> int: ...
  @event_context.setter
  def event_context(value) -> None: ...

  @property
  def status() -> int: ...
  @status.setter
  def status(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_open_file() -> Callable[[CBFilterBeforeOpenFileEventParams], None]: ...
@on_before_open_file.setter
def on_before_open_file(event_hook: Callable[[CBFilterBeforeOpenFileEventParams], None]) -> None: ...

Remarks

This event fires before the file or directory specified by FileName is opened. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. Please refer to the File Create/Open Events topic for more information about how the class determines whether to fire this event or on_before_create_file.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_CE_BEFORE_OPEN flag.

Note: Applications must have the FilterOwnRequests configuration setting enabled if they wish to filter their own file/directory open requests.

Note: Not everything is possible or allowed in the event handlers. For details, see the Recursive Calls topic.


BackendFileName Value	Description
`FileName`	By default `BackendFileName` is set to the same value as `FileName` and requests are directed to the original file.
Custom Path	Set `BackendFileName` to the full path of another file on disk to redirect requests to a different file.
`""` (empty string)	When set to an empty string, file-related events must be handled to provide all information and content for the file. This mode is useful for providing modified content on-the-fly, such as returning decrypted content for specific processes.

DesiredAccess may contain one or more of the following access flags:


DESIRED_ACCESS_FILE_LIST_DIRECTORY	`0x00000001`	For a directory, the right to list the contents of the directory.
DESIRED_ACCESS_FILE_READ_DATA	`0x00000001`	For a file object, the right to read the corresponding file data. For a directory object, the right to read the corresponding directory data.
DESIRED_ACCESS_FILE_ADD_FILE	`0x00000002`	For a directory, the right to create a file in the directory.
DESIRED_ACCESS_FILE_WRITE_DATA	`0x00000002`	For a file object, the right to write data to the file. For a directory object, the right to create a file in the directory
DESIRED_ACCESS_FILE_ADD_SUBDIRECTORY	`0x00000004`	For a directory, the right to create a subdirectory.
DESIRED_ACCESS_FILE_APPEND_DATA	`0x00000004`	For a file object, the right to append data to the file. (For local files, write operations will not overwrite existing data if this flag is specified without FILE_WRITE_DATA.) For a directory object, the right to create a subdirectory (FILE_ADD_SUBDIRECTORY).
DESIRED_ACCESS_FILE_READ_EA	`0x00000008`	The right to read extended file attributes.
DESIRED_ACCESS_FILE_WRITE_EA	`0x00000010`	The right to write extended file attributes.
DESIRED_ACCESS_FILE_EXECUTE	`0x00000020`	For a native code file, the right to execute the file. This access right given to scripts may cause the script to be executable, depending on the script interpreter.
DESIRED_ACCESS_FILE_DELETE_CHILD	`0x00000040`	For a directory, the right to delete a directory and all the files it contains, including read-only files.
DESIRED_ACCESS_FILE_READ_ATTRIBUTES	`0x00000080`	The right to read file attributes.
DESIRED_ACCESS_FILE_WRITE_ATTRIBUTES	`0x00000100`	The right to write file attributes.
DESIRED_ACCESS_READ_CONTROL	`0x00020000`	The right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_READ	`0x00020000`	Includes READ_CONTROL, which is the right to read the information in the file or directory object's security descriptor. This does not include the information in the SACL.
DESIRED_ACCESS_STANDARD_RIGHTS_WRITE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_STANDARD_RIGHTS_EXECUTE	`0x00020000`	Same as STANDARD_RIGHTS_READ
DESIRED_ACCESS_SYNCHRONIZE	`0x00100000`	The right to use the object for synchronization. This enables a thread to wait until the object is in the signaled state. Some object types do not support this access right.
DESIRED_ACCESS_FILE_ALL_ACCESS	`0x001F01FF`	All possible access rights for a file.
DESIRED_ACCESS_FILE_GENERIC_READ	`0x00120089`	A combinarion of flags that allow reading of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_WRITE	`0x00120116`	A combinarion of flags that allow modifications to the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.
DESIRED_ACCESS_FILE_GENERIC_EXECUTE	`0x001200A0`	A combinarion of flags that allow execution of the file. Note: Don't match received values against this flag. Instead, use flags that specify the rights that you want to verify or add/remove.

Attributes may contain one or more of the following attributes:


FILE_SYS_ATTR_READ_ONLY	`0x00000001`	The file is read-only. Applications can read the file, but cannot write to it or delete it. This attribute is not honored on directories.
FILE_SYS_ATTR_HIDDEN	`0x00000002`	The file or directory is hidden. The file is not included in an ordinary directory listing.
FILE_SYS_ATTR_SYSTEM	`0x00000004`	A file or directory that the operating system uses a part of, or uses exclusively.
FILE_SYS_ATTR_DIRECTORY	`0x00000010`	The entry is a directory.
FILE_SYS_ATTR_ARCHIVE	`0x00000020`	The entry is an archive file or directory. Applications typically use this attribute to mark files for backup or removal.
FILE_SYS_ATTR_NORMAL	`0x00000080`	A file doesn't have other attributes set. This attribute is valid only when used alone.
FILE_SYS_ATTR_TEMPORARY	`0x00000100`	A file that is being used for temporary storage. File systems avoid writing data back to mass storage if sufficient cache memory is available, because typically, an application deletes a temporary file after the handle is closed. In that scenario, the system can entirely avoid writing the data. Otherwise, the data are written after the handle is closed.
FILE_SYS_ATTR_SPARSE_FILE	`0x00000200`	A file that is a sparse file.
FILE_SYS_ATTR_REPARSE_POINT	`0x00000400`	A file that is a reparse point or a symbolic link.
FILE_SYS_ATTR_COMPRESSED	`0x00000800`	A file or directory that is compressed. For a file, all of the data in the file are compressed. For a directory, compression is the default for newly created files and subdirectories. A filesystem implementation can make use of this attribute by setting the support_compressed_attribute property to `True` and then properly handling the on_get_file_info, on_enumerate_directory, and on_set_file_attributes events.
FILE_SYS_ATTR_OFFLINE	`0x00001000`	The data of a file are not available immediately. This attribute indicates that the file data are physically moved to offline storage.
FILE_SYS_ATTR_NOT_CONTENT_INDEXED	`0x00002000`	The file or directory is not to be indexed by the content indexing service.
FILE_SYS_ATTR_ENCRYPTED	`0x00004000`	A file or directory that is encrypted. For a file, all data streams in the file are encrypted. For a directory, encryption is the default for newly created files and subdirectories. Note: This flag is used by NTFS and the OS sends undocumented requests to the filesystem based on this flag. The flag should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_VIRTUAL	`0x00010000`	Reserved. Note: This flag is reserved by the OS and should not be used for files in custom filesystem implementations.
FILE_SYS_ATTR_RECALL_ON_OPEN	`0x00040000`	The file or directory has no physical representation on the local system; the item is virtual. Opening the item will be more expensive than normal (e.g., it will cause at least some of it to be fetched from a remote store). This flag is reported by filesystems during directory enumerations.

ShareMode may contain zero or more of the following share mode flags:


FILESYS_SHARE_READ	`0x00000001`	Enables subsequent open operations on a file or device to request read access. Enables subsequent open operations to request read access; otherwise, no process can open the file or device if it requests read access. If this flag is not specified, but the file or device has been opened for read access, the function fails.
FILESYS_SHARE_WRITE	`0x00000002`	Enables subsequent open operations on a file or device to request write access. Enables subsequent open operations to request write access; otherwise, no process can open the file or device if it requests write access. If this flag is not specified, but the file or device has been opened for write access or has a file mapping with write access, the function fails.
FILESYS_SHARE_DELETE	`0x00000004`	Enables subsequent open operations on a file or device to request delete access. Enables subsequent open operations to request delete access; otherwise, no process can open the file or device if it requests delete access. If this flag is not specified, but the file or device has been opened for delete access, the function fails. Note: Delete access allows both delete and rename operations.

When the file being created or opened is virtual, the event handler must inspect and handle the value of the ShareMode parameter as a filesystem would normally do it.

CreateDisposition may contain one of the following values:


FILE_DISPOSITION_CREATE_NEW	`0x00000001`	Creates a new file, only if it does not already exist. If the specified file exists, the operation fails with an "already exists" error.
FILE_DISPOSITION_CREATE_ALWAYS	`0x00000002`	Creates a new file, always. If the specified file exists and is writable, the system overwrites the file. If the specified file does not exist and is a valid path, a new file is created.
FILE_DISPOSITION_OPEN_EXISTING	`0x00000003`	Opens a file, only if it exists If the specified file does not exist, opening fails.
FILE_DISPOSITION_OPEN_ALWAYS	`0x00000004`	Opens a file, always. If the specified file exists, the operation succeeds. If the specified file does not exist and is a valid path to a writable location, the a file is created.
FILE_DISPOSITION_TRUNCATE_EXISTING	`0x00000005`	Opens a file and truncates it so that its size is zero bytes, only if it exists. If the specified file does not exist, the operation fails with a "file not found" error.


FILE_DISPOSITION_CREATE_NEW	=>	CREATION_STATUS_CREATED
FILE_DISPOSITION_CREATE_ALWAYS	=>	CREATION_STATUS_OVERWRITTEN
FILE_DISPOSITION_OPEN_EXISTING	=>	CREATION_STATUS_OPENED
FILE_DISPOSITION_OPEN_ALWAYS	=>	CREATION_STATUS_OPENED
FILE_DISPOSITION_TRUNCATE_EXISTING	=>	CREATION_STATUS_OVERWRITTEN