CBMonitor Class

Properties   Methods   Events   Config Settings   Errors  

The CBMonitor class allows applications to monitor filesystem requests.

Syntax

class cbfsfilter.CBMonitor

Remarks

The CBMonitor class is a "monitoring-only" subset of the CBFilter class; it gives applications the ability to monitor filesystem requests, allowing them to be logged and reported. Applications use standard filter rules to specify which requests they are interested in monitoring.

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

Getting Started

1. 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 by the application's installation script using the Installer DLL. Please refer to the Driver Installation topic for more information.
2. Call the initialize method to initialize the CBMonitor class. This must be done each time the application starts.
3. Add one or more filter rules using methods like add_filter_rule. (Rules can also be added/removed after the filter is started.)
4. Call the start_filter method to start monitoring filesystem requests.
5. When finished, call the stop_filter method to stop monitoring filesystem requests.
6. 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.

Method List

---

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

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.

Config Settings

---

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

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.

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

0

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

0

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:

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

0

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:

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

0

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

0

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.

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 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

0

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

0

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

0

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:

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

0

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:

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.

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

0

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

0

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:

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

0

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:

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.

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 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

0

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 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

0

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.

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 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

0

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

0

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

0

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:

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_win_32_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).

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

0

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:

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

0

Remarks

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

add_filter_rule Method

This method adds a standard filter rule.

Syntax

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

Remarks

This method adds a standard filter 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.

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 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:

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_ex Method

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

Syntax

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

Remarks

This method adds a standard filter 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.

Standard filter rules determine which filesystem operations, of those performed on matching files and directories, the class should fire its events for.

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.

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:

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.

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_passthrough_rule Method

This method adds a passthrough rule.

Syntax

def add_passthrough_rule(mask: str, 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 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:

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_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, 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.

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.

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:

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.

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.

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.

delete_all_filter_rules Method

This method deletes all standard filter rules.

Syntax

def delete_all_filter_rules() -> bool: ...

Remarks

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

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

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

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.

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.

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.

delete_filter_rule Method

This method deletes a particular standard filter rule.

Syntax

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

Remarks

This method deletes the specified NotifyFlags from the standard filter rule identified by Mask. If NotifyFlags includes all flags currently present in the rule, then the entire rule is deleted; otherwise, the flags specified by NotifyFlags 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 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:

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

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.

delete_passthrough_rule Method

This method deletes a particular passthrough rule.

Syntax

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

Remarks

This method deletes the specified NotifyFlags from the passthrough rule identified by Mask. If NotifyFlags includes all flags currently present in the rule, then the entire rule is deleted; otherwise, the flags specified by NotifyFlags 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 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:

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

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.

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_dos_path_name Method

This method retrieves the DOS path name of the file or directory by its native (NT) path.

Syntax

def get_dos_path_name(nt_path: str) -> str: ...

Remarks

This method retrieves the DOS path name of the file or directory by its native path, specified in the NTPath parameter.

Note: Such name conversion is not always possible (e.g., the volume can have none or more than one DOS names). In this case, an empty string is returned.

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.

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:

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.

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_event_filename Method

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

Syntax

def get_event_filename() -> 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 filename, this method returns an empty string.

get_nt_path_name Method

This method retrieves the NT (native) path name of the file or directory by its DOS path.

Syntax

def get_nt_path_name(dos_path: str) -> str: ...

Remarks

This method retrieves the NT (native) path name of the file or directory by its path, specified in the DOSPath parameter.

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).

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 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:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. 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.

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 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:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. 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.

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:

1. Call this method within the on_create_file or on_open_file event.
2. Store the information somewhere, and store a reference to it in the event's HandleContext parameter.
3. 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_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.

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

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) -> 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.

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

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:

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.

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.

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.

Note: This method cannot be called within events.

nt_status_to_win_32_error Method

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

Syntax

def nt_status_to_win_32_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).

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() -> 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, as 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.

stop_filter Method

This method stops filtering filesystem operations.

Syntax

def stop_filter(reserved: bool) -> 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.

The Reserved parameter is obsolete.

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.

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.

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:

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.

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.

Note: This method cannot be called within events.

on_after_filter_attach_to_volume Event

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

Syntax

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

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

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

Remarks

This event fires after the filter attaches to the newly mounted filesystem volume specified by 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.

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.

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).

The format of the VolumeName parameter's value depends on whether the ResolveNtDeviceToDriveLetter configuration setting is enabled; please refer to its documentation for more information. 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 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 Reporting and Handling topic for more information.

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 CBMonitorAfterFilterDetachFromVolumeEventParams(object):
  @property
  def volume_name() -> str: ...

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

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

Remarks

This event fires after the filter detaches from the filesystem volume specified by 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.

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).

The format of the VolumeName parameter's value depends on whether the ResolveNtDeviceToDriveLetter configuration setting is enabled; please refer to its documentation for more information. 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 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 Reporting and Handling topic for more information.

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 CBMonitorBeforeFilterAttachToVolumeEventParams(object):
  @property
  def volume_name() -> 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 CBMonitor:
@property
def on_before_filter_attach_to_volume() -> Callable[[CBMonitorBeforeFilterAttachToVolumeEventParams], None]: ...
@on_before_filter_attach_to_volume.setter
def on_before_filter_attach_to_volume(event_hook: Callable[[CBMonitorBeforeFilterAttachToVolumeEventParams], None]) -> None: ...

Remarks

This event fires before the filter attaches to the newly mounted filesystem volume specified by 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.

The VolumeName parameter's value is always an NT native format in this event (unlike the other volume-related events, listed below, where its format depends on the ResolveNtDeviceToDriveLetter configuration setting). It is therefore recommended that applications add volume-specific rules, if desired, during the on_after_filter_attach_to_volume event rather than this one. 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

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 Reporting and Handling topic for more information.

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

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).

on_error Event

This event fires if an unhandled error occurs during an event.

Syntax

class CBMonitorErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class CBMonitor:
@property
def on_error() -> Callable[[CBMonitorErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CBMonitorErrorEventParams], None]) -> None: ...

Remarks

This event fires if an unhandled error occurs during another event. Developers can use this information to track down unhandled errors in an application's event handlers.

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

on_filter_start Event

This event fires once the filter has attached and filtering has started.

Syntax

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

# In class CBMonitor:
@property
def on_filter_start() -> Callable[[CBMonitorFilterStartEventParams], None]: ...
@on_filter_start.setter
def on_filter_start(event_hook: Callable[[CBMonitorFilterStartEventParams], None]) -> None: ...

Remarks

This event fires once the filter has attached and filtering has started; please refer to the start_filter method 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 Reporting and Handling topic for more information.

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

on_filter_stop Event

This event fires once filtering has stopped and the filter has detached.

Syntax

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

# In class CBMonitor:
@property
def on_filter_stop() -> Callable[[CBMonitorFilterStopEventParams], None]: ...
@on_filter_stop.setter
def on_filter_stop(event_hook: Callable[[CBMonitorFilterStopEventParams], None]) -> None: ...

Remarks

This event fires once filtering has stopped and the filter has detached.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_can_file_be_deleted Event

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

Syntax

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_can_file_be_deleted() -> Callable[[CBMonitorNotifyCanFileBeDeletedEventParams], None]: ...
@on_notify_can_file_be_deleted.setter
def on_notify_can_file_be_deleted(event_hook: Callable[[CBMonitorNotifyCanFileBeDeletedEventParams], None]) -> None: ...

Remarks

This event fires when the OS marks the file or directory specified by FileName for deletion or removes such a mark.

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_notify_create_file or on_notify_open_file event.

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

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

The CanDelete parameter reflects whether or not the file or directory can 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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_cleanup_file Event

This event fires when a file or directory handle has been closed.

Syntax

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

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

# In class CBMonitor:
@property
def on_notify_cleanup_file() -> Callable[[CBMonitorNotifyCleanupFileEventParams], None]: ...
@on_notify_cleanup_file.setter
def on_notify_cleanup_file(event_hook: Callable[[CBMonitorNotifyCleanupFileEventParams], None]) -> None: ...

Remarks

This event fires when a handle to the file or directory specified by FileName has been closed. This event differs from on_notify_close_file in that on_notify_cleanup_file fires when an open handle to the specified file or directory is closed by a process, whereas on_notify_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_notify_close_file event fires. For example, system components, such as the memory manager or cache manager, may cause the on_notify_read_file and on_notify_write_file events to fire.

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

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_close_file Event

This event fires when a file or directory has been closed.

Syntax

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

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

# In class CBMonitor:
@property
def on_notify_close_file() -> Callable[[CBMonitorNotifyCloseFileEventParams], None]: ...
@on_notify_close_file.setter
def on_notify_close_file(event_hook: Callable[[CBMonitorNotifyCloseFileEventParams], None]) -> None: ...

Remarks

This event fires when the file or directory specified by FileName has been closed.

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

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

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_create_file Event

This event fires when a file or directory has been created.

Syntax

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

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

  @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: ...

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

# In class CBMonitor:
@property
def on_notify_create_file() -> Callable[[CBMonitorNotifyCreateFileEventParams], None]: ...
@on_notify_create_file.setter
def on_notify_create_file(event_hook: Callable[[CBMonitorNotifyCreateFileEventParams], None]) -> None: ...

Remarks

This event fires when the file or directory specified by FileName has been created. Please refer to the File Create/Open Events topic for more information about how the class determines whether to fire this event or on_notify_open_file.

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

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

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.

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:

Attributes may contain one or more of the following attributes:

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

CreateDisposition may contain one of the following values:

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_notify_can_file_be_deleted event will fire after this event.

If the file is created with extended attributes passed in the request, the on_notify_set_ea event will fire after this event.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_create_hard_link Event

This event fires when a hard link has been created.

Syntax

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

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

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

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

# In class CBMonitor:
@property
def on_notify_create_hard_link() -> Callable[[CBMonitorNotifyCreateHardLinkEventParams], None]: ...
@on_notify_create_hard_link.setter
def on_notify_create_hard_link(event_hook: Callable[[CBMonitorNotifyCreateHardLinkEventParams], None]) -> None: ...

Remarks

This event fires when a hard link to the file specified by FileName has been created. 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_NE_CREATE_HARD_LINK flag.

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

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_delete_file Event

This event fires when a file or directory has been deleted.

Syntax

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

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

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

# In class CBMonitor:
@property
def on_notify_delete_file() -> Callable[[CBMonitorNotifyDeleteFileEventParams], None]: ...
@on_notify_delete_file.setter
def on_notify_delete_file(event_hook: Callable[[CBMonitorNotifyDeleteFileEventParams], None]) -> None: ...

Remarks

This event fires when the file or directory specified by FileName has been deleted. More specifically, this event is queued for delivery after the final IRP_MJ_CLOSE I/O request packet (IRP) has been 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_notify_close_file is queued.

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

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

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_delete_reparse_point Event

This event fires when a file or directory's reparse point has been deleted.

Syntax

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

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

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

# In class CBMonitor:
@property
def on_notify_delete_reparse_point() -> Callable[[CBMonitorNotifyDeleteReparsePointEventParams], None]: ...
@on_notify_delete_reparse_point.setter
def on_notify_delete_reparse_point(event_hook: Callable[[CBMonitorNotifyDeleteReparsePointEventParams], None]) -> None: ...

Remarks

This event fires when a reparse point has been deleted from the file or directory specified by FileName.

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

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

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_enumerate_directory Event

This event fires when a directory entry has been returned during directory enumeration.

Syntax

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

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

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

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

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_enumerate_directory() -> Callable[[CBMonitorNotifyEnumerateDirectoryEventParams], None]: ...
@on_notify_enumerate_directory.setter
def on_notify_enumerate_directory(event_hook: Callable[[CBMonitorNotifyEnumerateDirectoryEventParams], None]) -> None: ...

Remarks

This event fires when a directory entry (i.e., file or subdirectory) has been returned during enumeration of the directory specified by DirectoryName.

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

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

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 reflect the entry's time values, specified in UTC.

The Size parameter reflects the size of the file, in bytes; it is always 0 for subdirectories.

The AllocationSize parameter reflects the amount of space allocated for the file, in bytes; it is always 0 for subdirectories.

The FileId parameter reflects the unique Id of the entry, as reported by the filesystem. 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 reflects the entry's attributes; please refer to Microsoft's File Attribute Constants article for attribute descriptions.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_filter_attach_to_volume Event

This event fires when the filter has been attached to a newly mounted filesystem volume.

Syntax

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

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

# In class CBMonitor:
@property
def on_notify_filter_attach_to_volume() -> Callable[[CBMonitorNotifyFilterAttachToVolumeEventParams], None]: ...
@on_notify_filter_attach_to_volume.setter
def on_notify_filter_attach_to_volume(event_hook: Callable[[CBMonitorNotifyFilterAttachToVolumeEventParams], None]) -> None: ...

Remarks

This event fires when the filter has been attached to the newly mounted filesystem volume specified by 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_NOTIFY 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 that use volume-specific rules should typically add such rules during the on_after_filter_attach_to_volume event, which is fired synchronously, rather than this one.

The format of the VolumeName parameter's value depends on whether the ResolveNtDeviceToDriveLetter configuration setting is enabled; please refer to its documentation for more information. 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 ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

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).

on_notify_filter_detach_from_volume Event

This event fires when the filter has been detached from a filesystem volume.

Syntax

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

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

# In class CBMonitor:
@property
def on_notify_filter_detach_from_volume() -> Callable[[CBMonitorNotifyFilterDetachFromVolumeEventParams], None]: ...
@on_notify_filter_detach_from_volume.setter
def on_notify_filter_detach_from_volume(event_hook: Callable[[CBMonitorNotifyFilterDetachFromVolumeEventParams], None]) -> None: ...

Remarks

This event fires when the filter has been detached from the filesystem volume specified by VolumeName, typically as a result 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_NOTIFY 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 that use volume-specific rules typically should remove such rules during the on_after_filter_detach_from_volume event, which is fired synchronously, rather than this one.

The format of the VolumeName parameter's value depends on whether the ResolveNtDeviceToDriveLetter configuration setting is enabled; please refer to its documentation for more information. 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 ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

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).

on_notify_fsctl Event

This event fires when an IRP_MJ_FILE_SYSTEM_CONTROL operation has occurred.

Syntax

class CBMonitorNotifyFsctlEventParams(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: ...

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

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

# In class CBMonitor:
@property
def on_notify_fsctl() -> Callable[[CBMonitorNotifyFsctlEventParams], None]: ...
@on_notify_fsctl.setter
def on_notify_fsctl(event_hook: Callable[[CBMonitorNotifyFsctlEventParams], None]) -> None: ...

Remarks

This event fires when an IRP_MJ_FILE_SYSTEM_CONTROL (FSCTL) operation has occurred. 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 need to handle this event only if they have added a standard filter rule that includes the FS_NE_FSCTL flag.

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_get_file_security Event

This event fires when a file or directory's security attributes have been retrieved.

Syntax

class CBMonitorNotifyGetFileSecurityEventParams(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: ...

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

# In class CBMonitor:
@property
def on_notify_get_file_security() -> Callable[[CBMonitorNotifyGetFileSecurityEventParams], None]: ...
@on_notify_get_file_security.setter
def on_notify_get_file_security(event_hook: Callable[[CBMonitorNotifyGetFileSecurityEventParams], None]) -> None: ...

Remarks

This event fires when security attributes have been retrieved for the file or directory specified by FileName.

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_NE_GET_SECURITY flag.

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_get_file_sizes Event

This event fires when a file's size information has been retrieved.

Syntax

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_get_file_sizes() -> Callable[[CBMonitorNotifyGetFileSizesEventParams], None]: ...
@on_notify_get_file_sizes.setter
def on_notify_get_file_sizes(event_hook: Callable[[CBMonitorNotifyGetFileSizesEventParams], None]) -> None: ...

Remarks

This event fires when size information has been retrieved for the file specified by FileName.

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

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

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

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_get_reparse_point Event

This event fires when a file or directory's reparse point information has been retrieved.

Syntax

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

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

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

# In class CBMonitor:
@property
def on_notify_get_reparse_point() -> Callable[[CBMonitorNotifyGetReparsePointEventParams], None]: ...
@on_notify_get_reparse_point.setter
def on_notify_get_reparse_point(event_hook: Callable[[CBMonitorNotifyGetReparsePointEventParams], None]) -> None: ...

Remarks

This event fires when reparse point information has been retrieved for the file or directory specified by FileName.

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

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_ioctl Event

This event fires when an IRP_MJ_DEVICE_CONTROL operation has occurred.

Syntax

class CBMonitorNotifyIoctlEventParams(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: ...

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

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

# In class CBMonitor:
@property
def on_notify_ioctl() -> Callable[[CBMonitorNotifyIoctlEventParams], None]: ...
@on_notify_ioctl.setter
def on_notify_ioctl(event_hook: Callable[[CBMonitorNotifyIoctlEventParams], None]) -> None: ...

Remarks

This event fires when an IRP_MJ_DEVICE_CONTROL (IOCTL) operation has occurred. 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 need to handle this event only if they have added a standard filter rule that includes the FS_NE_IOCTL flag.

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

The IoControlCode parameter reflects the requested I/O control code (IOCTL).

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_lock Event

This event fires when a range of bytes in a file has been locked.

Syntax

class CBMonitorNotifyLockEventParams(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: ...

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

# In class CBMonitor:
@property
def on_notify_lock() -> Callable[[CBMonitorNotifyLockEventParams], None]: ...
@on_notify_lock.setter
def on_notify_lock(event_hook: Callable[[CBMonitorNotifyLockEventParams], None]) -> None: ...

Remarks

This event fires when a range of bytes in the file specified by FileName has been locked; 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_NE_LOCK_CONTROL flag.

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).

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_open_file Event

This event fires when a file or directory has been opened.

Syntax

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

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

  @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: ...

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

# In class CBMonitor:
@property
def on_notify_open_file() -> Callable[[CBMonitorNotifyOpenFileEventParams], None]: ...
@on_notify_open_file.setter
def on_notify_open_file(event_hook: Callable[[CBMonitorNotifyOpenFileEventParams], None]) -> None: ...

Remarks

This event fires when the file or directory specified by FileName has been opened. Please refer to the File Create/Open Events topic for more information about how the class determines whether to fire this event or on_notify_create_file.

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

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

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.

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:

Attributes may contain one or more of the following attributes:

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

CreateDisposition may contain one of the following values:

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_notify_can_file_be_deleted event will fire after this event.

If the file is opened with extended attributes passed in the request, the on_notify_set_ea event will fire after this event.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_query_ea Event

This event fires when information about the extended attributes of a file has been retrieved.

Syntax

class CBMonitorNotifyQueryEaEventParams(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: ...

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

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

# In class CBMonitor:
@property
def on_notify_query_ea() -> Callable[[CBMonitorNotifyQueryEaEventParams], None]: ...
@on_notify_query_ea.setter
def on_notify_query_ea(event_hook: Callable[[CBMonitorNotifyQueryEaEventParams], None]) -> None: ...

Remarks

This event fires when information about the extended attributes of a file specified by FileName has been retrieved.

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

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_query_file_info Event

This event fires when information about a file or directory has been retrieved.

Syntax

class CBMonitorNotifyQueryFileInfoEventParams(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: ...

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

# In class CBMonitor:
@property
def on_notify_query_file_info() -> Callable[[CBMonitorNotifyQueryFileInfoEventParams], None]: ...
@on_notify_query_file_info.setter
def on_notify_query_file_info(event_hook: Callable[[CBMonitorNotifyQueryFileInfoEventParams], None]) -> None: ...

Remarks

This event fires when information about a file or directory specified by FileName has been retrieved; This event typically fires in response to the Windows API's NtQueryInformationFile function.

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

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_read_file Event

This event fires when data have been read from a file.

Syntax

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

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

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_read_file() -> Callable[[CBMonitorNotifyReadFileEventParams], None]: ...
@on_notify_read_file.setter
def on_notify_read_file(event_hook: Callable[[CBMonitorNotifyReadFileEventParams], None]) -> None: ...

Remarks

This event fires when data have been read from a file specified by FileName.

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

The Position parameter reflects the byte offset in the file at which reading started.

The BytesToRead parameter reflects how many bytes were to be read from the file.

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:

The BytesRead parameter reflects how many bytes were actually read from the file.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_rename_or_move_file Event

This event fires when a file or directory has been renamed or moved.

Syntax

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

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

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

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

# In class CBMonitor:
@property
def on_notify_rename_or_move_file() -> Callable[[CBMonitorNotifyRenameOrMoveFileEventParams], None]: ...
@on_notify_rename_or_move_file.setter
def on_notify_rename_or_move_file(event_hook: Callable[[CBMonitorNotifyRenameOrMoveFileEventParams], None]) -> None: ...

Remarks

This event fires when a file or directory specified by FileName has been renamed or moved to NewFileName.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_NE_RENAME flag. A rule's mask is matched against both previous and new filenames, and the event will fire when either of the names matches the mask.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_allocation_size Event

This event fires when a file's allocation size has been changed.

Syntax

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

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

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

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

# In class CBMonitor:
@property
def on_notify_set_allocation_size() -> Callable[[CBMonitorNotifySetAllocationSizeEventParams], None]: ...
@on_notify_set_allocation_size.setter
def on_notify_set_allocation_size(event_hook: Callable[[CBMonitorNotifySetAllocationSizeEventParams], None]) -> None: ...

Remarks

This event fires when the allocation size of the file specified by FileName has been changed.

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

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_ea Event

This event fires when information about the extended attributes of a file has been changed.

Syntax

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_set_ea() -> Callable[[CBMonitorNotifySetEaEventParams], None]: ...
@on_notify_set_ea.setter
def on_notify_set_ea(event_hook: Callable[[CBMonitorNotifySetEaEventParams], None]) -> None: ...

Remarks

This event fires when information about the extended attributes of a file specified by FileName has been changed.

If the file is created or opened with extended attributes passed in the request, this event will fire shortly after the on_notify_create_file or on_notify_open_file event.

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

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_file_attributes Event

This event fires when a file or directory's attributes or times have been changed.

Syntax

class CBMonitorNotifySetFileAttributesEventParams(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: ...

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

# In class CBMonitor:
@property
def on_notify_set_file_attributes() -> Callable[[CBMonitorNotifySetFileAttributesEventParams], None]: ...
@on_notify_set_file_attributes.setter
def on_notify_set_file_attributes(event_hook: Callable[[CBMonitorNotifySetFileAttributesEventParams], None]) -> None: ...

Remarks

This event fires when the attributes or times of the file or directory specified by FileName have been changed.

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

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_file_info Event

This event fires when information about a file or directory has been changed.

Syntax

class CBMonitorNotifySetFileInfoEventParams(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: ...

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

# In class CBMonitor:
@property
def on_notify_set_file_info() -> Callable[[CBMonitorNotifySetFileInfoEventParams], None]: ...
@on_notify_set_file_info.setter
def on_notify_set_file_info(event_hook: Callable[[CBMonitorNotifySetFileInfoEventParams], None]) -> None: ...

Remarks

This event fires when information about a file or directory specified by FileName has been changed; 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_NE_QUERY_FILE_INFO flag.

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_file_security Event

This event fires when a file or directory's security attributes have been changed.

Syntax

class CBMonitorNotifySetFileSecurityEventParams(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: ...

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

# In class CBMonitor:
@property
def on_notify_set_file_security() -> Callable[[CBMonitorNotifySetFileSecurityEventParams], None]: ...
@on_notify_set_file_security.setter
def on_notify_set_file_security(event_hook: Callable[[CBMonitorNotifySetFileSecurityEventParams], None]) -> None: ...

Remarks

This event fires when security attributes have been changed for a file or directory specified by FileName.

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

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.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_file_size Event

This event fires when a file has been resized.

Syntax

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

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

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

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

# In class CBMonitor:
@property
def on_notify_set_file_size() -> Callable[[CBMonitorNotifySetFileSizeEventParams], None]: ...
@on_notify_set_file_size.setter
def on_notify_set_file_size(event_hook: Callable[[CBMonitorNotifySetFileSizeEventParams], None]) -> None: ...

Remarks

This event fires when the file specified by FileName has been resized, whether explicitly (e.g., truncation) or implicitly (i.e., as data are appended).

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

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

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_set_reparse_point Event

This event fires when a file or directory's reparse point has been created or updated.

Syntax

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

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

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

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

# In class CBMonitor:
@property
def on_notify_set_reparse_point() -> Callable[[CBMonitorNotifySetReparsePointEventParams], None]: ...
@on_notify_set_reparse_point.setter
def on_notify_set_reparse_point(event_hook: Callable[[CBMonitorNotifySetReparsePointEventParams], None]) -> None: ...

Remarks

This event fires when a reparse point has been created or updated for a file or directory specified by FileName.

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

The ReparseTag parameter contains the reparse tag, which is the value the system uses to identify the format of the reparse point data.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_unlock_all Event

This event fires when all locked byte ranges in a file have been unlocked.

Syntax

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

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

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

# In class CBMonitor:
@property
def on_notify_unlock_all() -> Callable[[CBMonitorNotifyUnlockAllEventParams], None]: ...
@on_notify_unlock_all.setter
def on_notify_unlock_all(event_hook: Callable[[CBMonitorNotifyUnlockAllEventParams], None]) -> None: ...

Remarks

This event fires when all locked byte ranges in the file specified by FileName have been unlocked.

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

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_unlock_all_by_key Event

This event fires when all locked byte ranges in a file, associated with a particular key, have been unlocked.

Syntax

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

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

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

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

# In class CBMonitor:
@property
def on_notify_unlock_all_by_key() -> Callable[[CBMonitorNotifyUnlockAllByKeyEventParams], None]: ...
@on_notify_unlock_all_by_key.setter
def on_notify_unlock_all_by_key(event_hook: Callable[[CBMonitorNotifyUnlockAllByKeyEventParams], None]) -> None: ...

Remarks

This event fires when all locked byte ranges in the file specified by FileName, and associated with the specified Key, have been unlocked.

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

The Key parameter contains the key value specified when the byte ranges were locked. Please refer to the on_notify_lock event's documentation for more information.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_unlock_single Event

This event fires when a particular locked byte range in a file has been unlocked.

Syntax

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

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_unlock_single() -> Callable[[CBMonitorNotifyUnlockSingleEventParams], None]: ...
@on_notify_unlock_single.setter
def on_notify_unlock_single(event_hook: Callable[[CBMonitorNotifyUnlockSingleEventParams], None]) -> None: ...

Remarks

This event fires when a particular locked byte range in a file specified by FileName has been unlocked.

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

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_notify_lock event's documentation for more information.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_notify_write_file Event

This event fires when data have been written to a file.

Syntax

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

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

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

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

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

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

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

# In class CBMonitor:
@property
def on_notify_write_file() -> Callable[[CBMonitorNotifyWriteFileEventParams], None]: ...
@on_notify_write_file.setter
def on_notify_write_file(event_hook: Callable[[CBMonitorNotifyWriteFileEventParams], None]) -> None: ...

Remarks

This event fires when data have been written to the file specified by FileName.

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

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 BytesToWrite parameter reflects how many bytes were to be written to the file.

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:

The BytesWritten parameter reflects how many bytes were actually written to the file.

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_win_32_error method.

Note: This event will not fire for failed requests unless the process_failed_requests property is enabled.

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, set it to a non-zero value to report an appropriate error.

Note: This event fires after the operation has already completed, so reporting an error will not actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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

on_worker_thread_creation Event

Fires just after a new worker thread is created.

Syntax

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

# In class CBMonitor:
@property
def on_worker_thread_creation() -> Callable[[CBMonitorWorkerThreadCreationEventParams], None]: ...
@on_worker_thread_creation.setter
def on_worker_thread_creation(event_hook: Callable[[CBMonitorWorkerThreadCreationEventParams], None]) -> None: ...

Remarks

This event fires just after a worker thread is created, in the context of that worker thread.

This event is optional; it is provided to give applications a chance to perform additional processing when a new worker thread is created, such as allocating per-thread objects.

The class maintains a pool of worker threads and uses them to fire events; please refer to the Threading and Concurrency 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 Reporting and Handling topic for more information.

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

on_worker_thread_termination Event

Fires just before a worker thread is terminated.

Syntax

class CBMonitorWorkerThreadTerminationEventParams(object):
# In class CBMonitor:
@property
def on_worker_thread_termination() -> Callable[[CBMonitorWorkerThreadTerminationEventParams], None]: ...
@on_worker_thread_termination.setter
def on_worker_thread_termination(event_hook: Callable[[CBMonitorWorkerThreadTerminationEventParams], None]) -> None: ...

Remarks

This event fires just before a worker thread is terminated, in the context of that worker thread.

This event is optional; it is provided to give applications a chance to perform additional processing before a worker thread is terminated, such as deallocating per-thread objects.

The class maintains a pool of worker threads and uses them to fire events; please refer to the Threading and Concurrency topic for more information.

Any errors that occur during this event are ignored.

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

CBMonitor Config Settings

The class accepts one or more of the following configuration settings. Configuration 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.

CBMonitor Config Settings

Base Config Settings

CBMonitor Errors

The class uses Windows error codes during operation as necessary. Please refer to the Error Reporting and Handling topic for more information.

Special Use Errors

	21   ERROR_NOT_READY: Reported by the methods of the class if initialize has not been called or did not succeed.
	575   ERROR_APP_INIT_FAILURE: Reported by the methods of the class if initialize has not been called or did not succeed. Differs from ERROR_NOT_READY (21) in that it indicates a specific situation in the internal code.
	588   ERROR_FS_DRIVER_REQUIRED: Reported if the required system module was not correctly installed for the given ProductGUID.
	614   ERROR_NO_CALLBACK_ACTIVE: Reported by any method that can only be called within event handlers if it is called outside an event handler.
	1292   ERROR_IMPLEMENTATION_LIMIT: Reported when the timeout value provided is less than 3 seconds.
	1314   ERROR_PRIVILEGE_NOT_HELD: Reported by any method that requires elevated permissions if it is called without such permissions.