CBMonitor Component

Properties   Methods   Events   Config Settings   Errors  

The CBMonitor class allows applications to monitor filesystem requests.

Syntax

cbfsfilter.CBMonitor

Remarks

The CBMonitor struct is a "monitoring-only" subset of the CBFilter struct; 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 struct's capabilities, please refer to the product's General Information topics.

Getting Started

1. If the struct'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 struct. This must be done each time the application starts.
3. Add one or more filter rules using methods like AddFilterRule. (Rules can also be added/removed after the filter is started.)
4. Call the StartFilter method to start monitoring filesystem requests.
5. When finished, call the StopFilter method to stop monitoring filesystem requests.
6. To uninstall the struct'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 component with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

Active Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) Active() (bool, error)

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

Altitude Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) Altitude() (string, error)
func (obj *CBMonitor) SetAltitude(value string) error

Default Value

""

Remarks

This property specifies the altitude that the struct'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.

Data Type

string

FilterRuleCount Property (CBMonitor Component)

The number of records in the FilterRule arrays.

Syntax

func (obj *CBMonitor) FilterRuleCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

• FilterRuleAccessFlags
• FilterRuleControlFlags
• FilterRuleEaName
• FilterRuleExcludedAttributes
• FilterRuleIncludedAttributes
• FilterRuleMask
• FilterRuleMaxSize
• FilterRuleMinSize
• FilterRuleNotifyFlags

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

This property is read-only.

Data Type

int32

FilterRuleAccessFlags Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleAccessFlags(FilterRuleIndex int32) (int32, error)

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 struct, which does not support access rules.

The FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int32

FilterRuleControlFlags Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleControlFlags(FilterRuleIndex int32) (int64, error)

Default Value

0

Remarks

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

This property indicates which filesystem operations, of those performed on matching files and directories, the struct 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 struct, which does not provide any Control Events for filesystem operations.

The FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int64

FilterRuleEaName Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleEaName(FilterRuleIndex int32) (string, error)

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 FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

string

FilterRuleExcludedAttributes Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleExcludedAttributes(FilterRuleIndex int32) (int64, error)

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 FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int64

FilterRuleIncludedAttributes Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleIncludedAttributes(FilterRuleIndex int32) (int64, error)

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 FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int64

FilterRuleMask Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleMask(FilterRuleIndex int32) (string, error)

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 struct 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 FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

string

FilterRuleMaxSize Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleMaxSize(FilterRuleIndex int32) (int64, error)

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 FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int64

FilterRuleMinSize Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleMinSize(FilterRuleIndex int32) (int64, error)

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 FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int64

FilterRuleNotifyFlags Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FilterRuleNotifyFlags(FilterRuleIndex int32) (int64, error)

Default Value

0

Remarks

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

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

The FilterRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FilterRuleCount property.

This property is read-only.

Data Type

int64

FireVolumeEvents Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FireVolumeEvents() (int32, error)
func (obj *CBMonitor) SetFireVolumeEvents(value int32) error

Default Value

0

Remarks

This property specifies the events that the struct 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 StartFilter 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.

Data Type

int32

NormalizeShortFileNames Property (CBMonitor Component)

CBFILTER_NORMALIZE_SHORT_FILE_NAMES_NEVER 0 CBFILTER_NORMALIZE_SHORT_FILE_NAMES_LOCAL_FS 1 CBFILTER_NORMALIZE_SHORT_FILE_NAMES_ALWAYS 2, TBD.

Syntax

func (obj *CBMonitor) NormalizeShortFileNames() (int32, error)
func (obj *CBMonitor) SetNormalizeShortFileNames(value int32) error

Default Value

0

Remarks

TBD.

Data Type

int32

PassthroughRuleCount Property (CBMonitor Component)

The number of records in the PassthroughRule arrays.

Syntax

func (obj *CBMonitor) PassthroughRuleCount() (int32, error)

Default Value

0

Remarks

This property controls the size of the following arrays:

• PassthroughRuleAccessFlags
• PassthroughRuleControlFlags
• PassthroughRuleEaName
• PassthroughRuleExcludedAttributes
• PassthroughRuleIncludedAttributes
• PassthroughRuleMask
• PassthroughRuleMaxSize
• PassthroughRuleMinSize
• PassthroughRuleNotifyFlags

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

This property is read-only.

Data Type

int32

PassthroughRuleAccessFlags Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleAccessFlags(PassthroughRuleIndex int32) (int32, error)

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 struct, which does not support access rules.

The PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int32

PassthroughRuleControlFlags Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleControlFlags(PassthroughRuleIndex int32) (int64, error)

Default Value

0

Remarks

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

This property indicates which filesystem operations, of those performed on matching files and directories, the struct 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 struct, which does not provide any Control Events for filesystem operations.

The PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int64

PassthroughRuleEaName Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleEaName(PassthroughRuleIndex int32) (string, error)

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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

string

PassthroughRuleExcludedAttributes Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleExcludedAttributes(PassthroughRuleIndex int32) (int64, error)

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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int64

PassthroughRuleIncludedAttributes Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleIncludedAttributes(PassthroughRuleIndex int32) (int64, error)

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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int64

PassthroughRuleMask Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleMask(PassthroughRuleIndex int32) (string, error)

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 struct 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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

string

PassthroughRuleMaxSize Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleMaxSize(PassthroughRuleIndex int32) (int64, error)

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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int64

PassthroughRuleMinSize Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleMinSize(PassthroughRuleIndex int32) (int64, error)

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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int64

PassthroughRuleNotifyFlags Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) PassthroughRuleNotifyFlags(PassthroughRuleIndex int32) (int64, error)

Default Value

0

Remarks

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

This property indicates which filesystem operations, of those performed on matching files and directories, the struct 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 PassthroughRuleIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PassthroughRuleCount property.

This property is read-only.

Data Type

int64

ProcessCachedIORequests Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) ProcessCachedIORequests() (bool, error)
func (obj *CBMonitor) SetProcessCachedIORequests(value bool) error

Default Value

false

Remarks

This property specifies whether the struct'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.

Data Type

bool

ProcessFailedRequests Property (CBMonitor Component)

This property specifies whether failed requests should be processed.

Syntax

func (obj *CBMonitor) ProcessFailedRequests() (bool, error)
func (obj *CBMonitor) SetProcessFailedRequests(value bool) error

Default Value

false

Remarks

This property specifies whether the struct'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 NtStatusToWin32Error 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).

Data Type

bool

SerializeEvents Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) SerializeEvents() (int32, error)
func (obj *CBMonitor) SetSerializeEvents(value int32) error

Default Value

0

Remarks

This property specifies whether the struct 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.

Data Type

int32

Tag Property (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) Tag() (int64, error)
func (obj *CBMonitor) SetTag(value int64) error

Default Value

0

Remarks

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

Data Type

int64

AddFilterRule Method (CBMonitor Component)

This method adds a standard filter rule.

Syntax

func (obj *CBMonitor) AddFilterRule(Mask string, NotifyFlags int64) (bool, error)

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 struct 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 struct should fire Notification Events for. For example, if the FS_NE_READ flag is present, the NotifyReadFile 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

AddFilterRuleEx Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) AddFilterRuleEx(Mask string, EaName string, NotifyFlags int64, MinSize int64, MaxSize int64, IncludedAttributes int64, ExcludedAttributes int64) (bool, error)

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 struct 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 struct should fire Notification Events for. For example, if the FS_NE_READ flag is present, the NotifyReadFile 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

AddPassthroughRule Method (CBMonitor Component)

This method adds a passthrough rule.

Syntax

func (obj *CBMonitor) AddPassthroughRule(Mask string, NotifyFlags int64) (bool, error)

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 struct 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

AddPassthroughRuleEx Method (CBMonitor Component)

This method adds a passthrough rule with additional match qualifiers.

Syntax

func (obj *CBMonitor) AddPassthroughRuleEx(Mask string, EaName string, NotifyFlags int64, MinSize int64, MaxSize int64, IncludedAttributes int64, ExcludedAttributes int64) (bool, error)

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 struct 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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 (CBMonitor Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *CBMonitor) Config(ConfigurationString string) (string, error)

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

DeleteAllFilterRules Method (CBMonitor Component)

This method deletes all standard filter rules.

Syntax

func (obj *CBMonitor) DeleteAllFilterRules() (bool, error)

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 DeleteFilterRule 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

DeleteAllPassthroughRules Method (CBMonitor Component)

This method deletes all passthrough rules.

Syntax

func (obj *CBMonitor) DeleteAllPassthroughRules() (bool, error)

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 DeletePassthroughRule 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

DeleteFilterRule Method (CBMonitor Component)

This method deletes a particular standard filter rule.

Syntax

func (obj *CBMonitor) DeleteFilterRule(Mask string, NotifyFlags int64) (bool, error)

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 DeleteAllFilterRules 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

DeletePassthroughRule Method (CBMonitor Component)

This method deletes a particular passthrough rule.

Syntax

func (obj *CBMonitor) DeletePassthroughRule(Mask string, NotifyFlags int64) (bool, error)

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 DeleteAllPassthroughRules 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 AfterFilterAttachToVolume and AfterFilterDetachFromVolume 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.

FileMatchesMask Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) FileMatchesMask(Mask string, FileName string, CaseSensitive bool) (bool, error)

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

GetDOSPathName Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetDOSPathName(NTPath string) (string, error)

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.

GetDriverStatus Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetDriverStatus(ProductGUID string) (int32, error)

Remarks

This method retrieves the status of the struct'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
• GetDriverStatus
• GetDriverVersion
• Initialize

This method is available in both the struct 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.

GetDriverVersion Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetDriverVersion(ProductGUID string) (int64, error)

Remarks

This method retrieves the version of the struct'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 struct'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
• GetDriverStatus
• GetDriverVersion
• Initialize

This method is available in both the struct 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.

GetEventFileName Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetEventFileName() (string, error)

Remarks

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

GetNTPathName Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetNTPathName(DOSPath string) (string, error)

Remarks

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

GetOperationTime Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetOperationTime() (time.Time, error)

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.

GetOriginatorProcessId Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetOriginatorProcessId() (int32, error)

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 CreateFile or OpenFile 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 CleanupContext event handlers.

GetOriginatorProcessName Method (CBMonitor Component)

Retrieves the name of the process that initiated the operation.

Syntax

func (obj *CBMonitor) GetOriginatorProcessName() (string, error)

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 CreateFile or OpenFile 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 CleanupContext event handlers.

GetOriginatorThreadId Method (CBMonitor Component)

Retrieves the Id of the thread that initiated the operation.

Syntax

func (obj *CBMonitor) GetOriginatorThreadId() (int32, error)

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 CreateFile or OpenFile 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 CleanupContext event handlers.

GetRemoteAccessInformation Method (CBMonitor Component)

This method returns networking-related information about the operation.

Syntax

func (obj *CBMonitor) GetRemoteAccessInformation(ShareName *string, ClientSocketAddressBuffer int64, ClientSocketAddressBufferSize *int32) error

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.

GetVolumeGUID Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) GetVolumeGUID() (string, error)

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 (CBMonitor Component)

This method initializes the class.

Syntax

func (obj *CBMonitor) Initialize(ProductGUID string) error

Remarks

This method initializes the struct and must be called each time the application starts before attempting to call any of the struct'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
• GetDriverStatus
• GetDriverVersion
• 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 struct can be used.

Install Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) Install(CabFileName string, ProductGUID string, PathToInstall string, Altitude string, Flags int32, AllowedControllers string) (bool, error)

Remarks

This method is used to install or upgrade the struct'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 struct'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 struct'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
• GetDriverStatus
• GetDriverVersion
• 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.

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

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

This method is available in both the struct 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.

NtStatusToWin32Error Method (CBMonitor Component)

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

Syntax

func (obj *CBMonitor) NtStatusToWin32Error(Status int32) (int32, error)

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

ShutdownSystem Method (CBMonitor Component)

Shuts down or reboots the operating system.

Syntax

func (obj *CBMonitor) ShutdownSystem(ShutdownPrompt string, Timeout int32, ForceCloseApps bool, Reboot bool) (bool, error)

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

StartFilter Method (CBMonitor Component)

This method starts filtering filesystem operations.

Syntax

func (obj *CBMonitor) StartFilter() error

Remarks

This method attaches the filter, causing the struct'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 struct'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.

StopFilter Method (CBMonitor Component)

This method stops filtering filesystem operations.

Syntax

func (obj *CBMonitor) StopFilter() error

Remarks

This method detaches the filter, causing the struct'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.

Uninstall Method (CBMonitor Component)

This method uninstalls the class's system driver.

Syntax

func (obj *CBMonitor) Uninstall(CabFileName string, ProductGUID string, InstalledPath string, Flags int32) (bool, error)

Remarks

This method is used to uninstall the struct'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 struct'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 struct'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 struct 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.

AfterFilterAttachToVolume Event (CBMonitor Component)

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

Syntax

// CBMonitorAfterFilterAttachToVolumeEventArgs carries the CBMonitor AfterFilterAttachToVolume event's parameters.
type CBMonitorAfterFilterAttachToVolumeEventArgs struct {...}

func (args *CBMonitorAfterFilterAttachToVolumeEventArgs) VolumeName() string
func (args *CBMonitorAfterFilterAttachToVolumeEventArgs) VolumeNameNT() string
func (args *CBMonitorAfterFilterAttachToVolumeEventArgs) ResultCode() int32
func (args *CBMonitorAfterFilterAttachToVolumeEventArgs) SetResultCode(value int32)

// CBMonitorAfterFilterAttachToVolumeEvent defines the signature of the CBMonitor AfterFilterAttachToVolume event's handler function.
type CBMonitorAfterFilterAttachToVolumeEvent func(sender *CBMonitor, args *CBMonitorAfterFilterAttachToVolumeEventArgs)

func (obj *CBMonitor) GetOnAfterFilterAttachToVolumeHandler() CBMonitorAfterFilterAttachToVolumeEvent
func (obj *CBMonitor) SetOnAfterFilterAttachToVolumeHandler(handlerFunc CBMonitorAfterFilterAttachToVolumeEvent)

Remarks

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

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

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

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

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

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

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

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Handling topic for more information.

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

AfterFilterDetachFromVolume Event (CBMonitor Component)

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

Syntax

// CBMonitorAfterFilterDetachFromVolumeEventArgs carries the CBMonitor AfterFilterDetachFromVolume event's parameters.
type CBMonitorAfterFilterDetachFromVolumeEventArgs struct {...}

func (args *CBMonitorAfterFilterDetachFromVolumeEventArgs) VolumeName() string
func (args *CBMonitorAfterFilterDetachFromVolumeEventArgs) VolumeNameNT() string
func (args *CBMonitorAfterFilterDetachFromVolumeEventArgs) ResultCode() int32
func (args *CBMonitorAfterFilterDetachFromVolumeEventArgs) SetResultCode(value int32)

// CBMonitorAfterFilterDetachFromVolumeEvent defines the signature of the CBMonitor AfterFilterDetachFromVolume event's handler function.
type CBMonitorAfterFilterDetachFromVolumeEvent func(sender *CBMonitor, args *CBMonitorAfterFilterDetachFromVolumeEventArgs)

func (obj *CBMonitor) GetOnAfterFilterDetachFromVolumeHandler() CBMonitorAfterFilterDetachFromVolumeEvent
func (obj *CBMonitor) SetOnAfterFilterDetachFromVolumeHandler(handlerFunc CBMonitorAfterFilterDetachFromVolumeEvent)

Remarks

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

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

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

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

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

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

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Handling topic for more information.

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

BeforeFilterAttachToVolume Event (CBMonitor Component)

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

Syntax

// CBMonitorBeforeFilterAttachToVolumeEventArgs carries the CBMonitor BeforeFilterAttachToVolume event's parameters.
type CBMonitorBeforeFilterAttachToVolumeEventArgs struct {...}

func (args *CBMonitorBeforeFilterAttachToVolumeEventArgs) VolumeName() string
func (args *CBMonitorBeforeFilterAttachToVolumeEventArgs) VolumeNameNT() string
func (args *CBMonitorBeforeFilterAttachToVolumeEventArgs) SkipVolume() bool
func (args *CBMonitorBeforeFilterAttachToVolumeEventArgs) SetSkipVolume(value bool)

func (args *CBMonitorBeforeFilterAttachToVolumeEventArgs) ResultCode() int32
func (args *CBMonitorBeforeFilterAttachToVolumeEventArgs) SetResultCode(value int32)

// CBMonitorBeforeFilterAttachToVolumeEvent defines the signature of the CBMonitor BeforeFilterAttachToVolume event's handler function.
type CBMonitorBeforeFilterAttachToVolumeEvent func(sender *CBMonitor, args *CBMonitorBeforeFilterAttachToVolumeEventArgs)

func (obj *CBMonitor) GetOnBeforeFilterAttachToVolumeHandler() CBMonitorBeforeFilterAttachToVolumeEvent
func (obj *CBMonitor) SetOnBeforeFilterAttachToVolumeHandler(handlerFunc CBMonitorBeforeFilterAttachToVolumeEvent)

Remarks

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

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

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

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

The SkipVolume parameter specifies whether the struct'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 struct's system driver. It also will prevent any of the following events from firing for the volume:

• AfterFilterAttachToVolume
• NotifyFilterAttachToVolume
• AfterFilterDetachFromVolume
• NotifyFilterDetachFromVolume

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource is not available or security checks failed), set it to a nonzero value to report an appropriate error. Please see the Error Handling topic for more information.

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

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

BypassIORequest Event (CBMonitor Component)

This event fires when the OS sends one of BypassIO commands.

Syntax

// CBMonitorBypassIORequestEventArgs carries the CBMonitor BypassIORequest event's parameters.
type CBMonitorBypassIORequestEventArgs struct {...}

func (args *CBMonitorBypassIORequestEventArgs) FileName() string
func (args *CBMonitorBypassIORequestEventArgs) RequestCode() int32
func (args *CBMonitorBypassIORequestEventArgs) Status() int32
func (args *CBMonitorBypassIORequestEventArgs) SetStatus(value int32)

func (args *CBMonitorBypassIORequestEventArgs) Reason() string
func (args *CBMonitorBypassIORequestEventArgs) SetReason(value string)

// CBMonitorBypassIORequestEvent defines the signature of the CBMonitor BypassIORequest event's handler function.
type CBMonitorBypassIORequestEvent func(sender *CBMonitor, args *CBMonitorBypassIORequestEventArgs)

func (obj *CBMonitor) GetOnBypassIORequestHandler() CBMonitorBypassIORequestEvent
func (obj *CBMonitor) SetOnBypassIORequestHandler(handlerFunc CBMonitorBypassIORequestEvent)

Remarks

This event fires when the OS sends a BypassIO request to a file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

If BypassIO is enabled successfully future operations on the specified file handle will not be visible to the struct. To ensure all future operations on the file are visible to the struct BypassIO should not be enabled. BypassIO is present in Windows 11; it is not used in Windows 10 and earlier systems, and also is not used in Server systems.

Applications need to handle this event only if they have added a standard filter rule that includes the any of the following flags: FS_BYPASS_IO (it should be passed among notification flags), FS_CE_BEFORE_READ, FS_CE_AFTER_READ, FS_CE_BEFORE_WRITE, FS_CE_AFTER_WRITE.

The RequestCode parameter contains the code of the request. The code may be the one of the following:

When the request code is BPIO_OP_ENABLE, an application is able to block BypassIO by specifying a non-zero value for Status and a description of the reason in the Reason parameter. If the application does so, it should return the same status and reason in response to BPIO_OP_QUERY requests to let the caller know that enabling would not be possible. BPIO_OP_QUERY requests are used, in particular, by diagnostics tools. Other operations may not be denied, and when the event is fired for one of those other operations, the struct ignores the values returned in the Status and Reason parameters.

The Status value should be one of the NTStatus codes defined in Windows SDK (Windows 11 SDK defines a group of STATUS_NOT_SUPPORTED_WITH_* constants for this).

The Reason should be set to a human-readable text that explains why BypassIO was blocked.

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

Error Event (CBMonitor Component)

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

Syntax

// CBMonitorErrorEventArgs carries the CBMonitor Error event's parameters.
type CBMonitorErrorEventArgs struct {...}

func (args *CBMonitorErrorEventArgs) ErrorCode() int32
func (args *CBMonitorErrorEventArgs) Description() string
// CBMonitorErrorEvent defines the signature of the CBMonitor Error event's handler function.
type CBMonitorErrorEvent func(sender *CBMonitor, args *CBMonitorErrorEventArgs)

func (obj *CBMonitor) GetOnErrorHandler() CBMonitorErrorEvent
func (obj *CBMonitor) SetOnErrorHandler(handlerFunc CBMonitorErrorEvent)

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.

FilterStart Event (CBMonitor Component)

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

Syntax

// CBMonitorFilterStartEventArgs carries the CBMonitor FilterStart event's parameters.
type CBMonitorFilterStartEventArgs struct {...}

func (args *CBMonitorFilterStartEventArgs) ResultCode() int32
func (args *CBMonitorFilterStartEventArgs) SetResultCode(value int32)

// CBMonitorFilterStartEvent defines the signature of the CBMonitor FilterStart event's handler function.
type CBMonitorFilterStartEvent func(sender *CBMonitor, args *CBMonitorFilterStartEventArgs)

func (obj *CBMonitor) GetOnFilterStartHandler() CBMonitorFilterStartEvent
func (obj *CBMonitor) SetOnFilterStartHandler(handlerFunc CBMonitorFilterStartEvent)

Remarks

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

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

FilterStop Event (CBMonitor Component)

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

Syntax

// CBMonitorFilterStopEventArgs carries the CBMonitor FilterStop event's parameters.
type CBMonitorFilterStopEventArgs struct {...}

func (args *CBMonitorFilterStopEventArgs) ResultCode() int32
func (args *CBMonitorFilterStopEventArgs) SetResultCode(value int32)

// CBMonitorFilterStopEvent defines the signature of the CBMonitor FilterStop event's handler function.
type CBMonitorFilterStopEvent func(sender *CBMonitor, args *CBMonitorFilterStopEventArgs)

func (obj *CBMonitor) GetOnFilterStopHandler() CBMonitorFilterStopEvent
func (obj *CBMonitor) SetOnFilterStopHandler(handlerFunc CBMonitorFilterStopEvent)

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

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

NotifyCanFileBeDeleted Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyCanFileBeDeletedEventArgs carries the CBMonitor NotifyCanFileBeDeleted event's parameters.
type CBMonitorNotifyCanFileBeDeletedEventArgs struct {...}

func (args *CBMonitorNotifyCanFileBeDeletedEventArgs) FileName() string
func (args *CBMonitorNotifyCanFileBeDeletedEventArgs) RequestType() int32
func (args *CBMonitorNotifyCanFileBeDeletedEventArgs) CanDelete() bool
func (args *CBMonitorNotifyCanFileBeDeletedEventArgs) Status() int32
func (args *CBMonitorNotifyCanFileBeDeletedEventArgs) ResultCode() int32
func (args *CBMonitorNotifyCanFileBeDeletedEventArgs) SetResultCode(value int32)

// CBMonitorNotifyCanFileBeDeletedEvent defines the signature of the CBMonitor NotifyCanFileBeDeleted event's handler function.
type CBMonitorNotifyCanFileBeDeletedEvent func(sender *CBMonitor, args *CBMonitorNotifyCanFileBeDeletedEventArgs)

func (obj *CBMonitor) GetOnNotifyCanFileBeDeletedHandler() CBMonitorNotifyCanFileBeDeletedEvent
func (obj *CBMonitor) SetOnNotifyCanFileBeDeletedHandler(handlerFunc CBMonitorNotifyCanFileBeDeletedEvent)

Remarks

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

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 NotifyCreateFile or NotifyOpenFile 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyCleanupFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyCleanupFileEventArgs carries the CBMonitor NotifyCleanupFile event's parameters.
type CBMonitorNotifyCleanupFileEventArgs struct {...}

func (args *CBMonitorNotifyCleanupFileEventArgs) FileName() string
func (args *CBMonitorNotifyCleanupFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyCleanupFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyCleanupFileEvent defines the signature of the CBMonitor NotifyCleanupFile event's handler function.
type CBMonitorNotifyCleanupFileEvent func(sender *CBMonitor, args *CBMonitorNotifyCleanupFileEventArgs)

func (obj *CBMonitor) GetOnNotifyCleanupFileHandler() CBMonitorNotifyCleanupFileEvent
func (obj *CBMonitor) SetOnNotifyCleanupFileHandler(handlerFunc CBMonitorNotifyCleanupFileEvent)

Remarks

This event fires when a handle to the file or directory specified by FileName has been closed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event differs from NotifyCloseFile in that NotifyCleanupFile fires when an open handle to the specified file or directory is closed by a process, whereas NotifyCloseFile 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 NotifyCloseFile event fires. For example, system components, such as the memory manager or cache manager, may cause the NotifyReadFile and NotifyWriteFile 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 Handling topic for more information.

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

NotifyCloseFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyCloseFileEventArgs carries the CBMonitor NotifyCloseFile event's parameters.
type CBMonitorNotifyCloseFileEventArgs struct {...}

func (args *CBMonitorNotifyCloseFileEventArgs) FileName() string
func (args *CBMonitorNotifyCloseFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyCloseFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyCloseFileEvent defines the signature of the CBMonitor NotifyCloseFile event's handler function.
type CBMonitorNotifyCloseFileEvent func(sender *CBMonitor, args *CBMonitorNotifyCloseFileEventArgs)

func (obj *CBMonitor) GetOnNotifyCloseFileHandler() CBMonitorNotifyCloseFileEvent
func (obj *CBMonitor) SetOnNotifyCloseFileHandler(handlerFunc CBMonitorNotifyCloseFileEvent)

Remarks

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

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

If the file or directory was marked for deletion earlier, the NotifyDeleteFile 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 Handling topic for more information.

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

NotifyCreateFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyCreateFileEventArgs carries the CBMonitor NotifyCreateFile event's parameters.
type CBMonitorNotifyCreateFileEventArgs struct {...}

func (args *CBMonitorNotifyCreateFileEventArgs) FileName() string
func (args *CBMonitorNotifyCreateFileEventArgs) ExistingAttributes() int32
func (args *CBMonitorNotifyCreateFileEventArgs) DesiredAccess() int32
func (args *CBMonitorNotifyCreateFileEventArgs) Attributes() int32
func (args *CBMonitorNotifyCreateFileEventArgs) ShareMode() int32
func (args *CBMonitorNotifyCreateFileEventArgs) Options() int32
func (args *CBMonitorNotifyCreateFileEventArgs) CreateDisposition() int32
func (args *CBMonitorNotifyCreateFileEventArgs) SecurityDescriptor() []byte
func (args *CBMonitorNotifyCreateFileEventArgs) Length() int32
func (args *CBMonitorNotifyCreateFileEventArgs) Status() int32
func (args *CBMonitorNotifyCreateFileEventArgs) CreationStatus() int32
func (args *CBMonitorNotifyCreateFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyCreateFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyCreateFileEvent defines the signature of the CBMonitor NotifyCreateFile event's handler function.
type CBMonitorNotifyCreateFileEvent func(sender *CBMonitor, args *CBMonitorNotifyCreateFileEventArgs)

func (obj *CBMonitor) GetOnNotifyCreateFileHandler() CBMonitorNotifyCreateFileEvent
func (obj *CBMonitor) SetOnNotifyCreateFileHandler(handlerFunc CBMonitorNotifyCreateFileEvent)

Remarks

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

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

If the file is created with extended attributes passed in the request, the NotifySetEa 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 NtStatusToWin32Error method.

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

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

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

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

NotifyCreateHardLink Event (CBMonitor Component)

This event fires when a hard link has been created.

Syntax

// CBMonitorNotifyCreateHardLinkEventArgs carries the CBMonitor NotifyCreateHardLink event's parameters.
type CBMonitorNotifyCreateHardLinkEventArgs struct {...}

func (args *CBMonitorNotifyCreateHardLinkEventArgs) FileName() string
func (args *CBMonitorNotifyCreateHardLinkEventArgs) LinkName() string
func (args *CBMonitorNotifyCreateHardLinkEventArgs) Status() int32
func (args *CBMonitorNotifyCreateHardLinkEventArgs) ResultCode() int32
func (args *CBMonitorNotifyCreateHardLinkEventArgs) SetResultCode(value int32)

// CBMonitorNotifyCreateHardLinkEvent defines the signature of the CBMonitor NotifyCreateHardLink event's handler function.
type CBMonitorNotifyCreateHardLinkEvent func(sender *CBMonitor, args *CBMonitorNotifyCreateHardLinkEventArgs)

func (obj *CBMonitor) GetOnNotifyCreateHardLinkHandler() CBMonitorNotifyCreateHardLinkEvent
func (obj *CBMonitor) SetOnNotifyCreateHardLinkHandler(handlerFunc CBMonitorNotifyCreateHardLinkEvent)

Remarks

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

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyDeleteFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyDeleteFileEventArgs carries the CBMonitor NotifyDeleteFile event's parameters.
type CBMonitorNotifyDeleteFileEventArgs struct {...}

func (args *CBMonitorNotifyDeleteFileEventArgs) FileName() string
func (args *CBMonitorNotifyDeleteFileEventArgs) RequestType() int32
func (args *CBMonitorNotifyDeleteFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyDeleteFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyDeleteFileEvent defines the signature of the CBMonitor NotifyDeleteFile event's handler function.
type CBMonitorNotifyDeleteFileEvent func(sender *CBMonitor, args *CBMonitorNotifyDeleteFileEventArgs)

func (obj *CBMonitor) GetOnNotifyDeleteFileHandler() CBMonitorNotifyDeleteFileEvent
func (obj *CBMonitor) SetOnNotifyDeleteFileHandler(handlerFunc CBMonitorNotifyDeleteFileEvent)

Remarks

This event fires when the file or directory specified by FileName has been deleted. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. More specifically, this event is 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 NotifyCloseFile 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 Handling topic for more information.

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

NotifyDeleteReparsePoint Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyDeleteReparsePointEventArgs carries the CBMonitor NotifyDeleteReparsePoint event's parameters.
type CBMonitorNotifyDeleteReparsePointEventArgs struct {...}

func (args *CBMonitorNotifyDeleteReparsePointEventArgs) FileName() string
func (args *CBMonitorNotifyDeleteReparsePointEventArgs) Status() int32
func (args *CBMonitorNotifyDeleteReparsePointEventArgs) ResultCode() int32
func (args *CBMonitorNotifyDeleteReparsePointEventArgs) SetResultCode(value int32)

// CBMonitorNotifyDeleteReparsePointEvent defines the signature of the CBMonitor NotifyDeleteReparsePoint event's handler function.
type CBMonitorNotifyDeleteReparsePointEvent func(sender *CBMonitor, args *CBMonitorNotifyDeleteReparsePointEventArgs)

func (obj *CBMonitor) GetOnNotifyDeleteReparsePointHandler() CBMonitorNotifyDeleteReparsePointEvent
func (obj *CBMonitor) SetOnNotifyDeleteReparsePointHandler(handlerFunc CBMonitorNotifyDeleteReparsePointEvent)

Remarks

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

Note: 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyEnumerateDirectory Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyEnumerateDirectoryEventArgs carries the CBMonitor NotifyEnumerateDirectory event's parameters.
type CBMonitorNotifyEnumerateDirectoryEventArgs struct {...}

func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) DirectoryName() string
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) Flags() int32
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) Index() int32
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) FileName() string
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) CreationTime() time.Time
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) LastAccessTime() time.Time
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) LastWriteTime() time.Time
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) ChangeTime() time.Time
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) Size() int64
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) AllocationSize() int64
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) FileId() int64
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) Attributes() int32
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) Status() int32
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) ResultCode() int32
func (args *CBMonitorNotifyEnumerateDirectoryEventArgs) SetResultCode(value int32)

// CBMonitorNotifyEnumerateDirectoryEvent defines the signature of the CBMonitor NotifyEnumerateDirectory event's handler function.
type CBMonitorNotifyEnumerateDirectoryEvent func(sender *CBMonitor, args *CBMonitorNotifyEnumerateDirectoryEventArgs)

func (obj *CBMonitor) GetOnNotifyEnumerateDirectoryHandler() CBMonitorNotifyEnumerateDirectoryEvent
func (obj *CBMonitor) SetOnNotifyEnumerateDirectoryHandler(handlerFunc CBMonitorNotifyEnumerateDirectoryEvent)

Remarks

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

Applications 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyFilterAttachToVolume Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyFilterAttachToVolumeEventArgs carries the CBMonitor NotifyFilterAttachToVolume event's parameters.
type CBMonitorNotifyFilterAttachToVolumeEventArgs struct {...}

func (args *CBMonitorNotifyFilterAttachToVolumeEventArgs) VolumeName() string
func (args *CBMonitorNotifyFilterAttachToVolumeEventArgs) VolumeNameNT() string
func (args *CBMonitorNotifyFilterAttachToVolumeEventArgs) ResultCode() int32
func (args *CBMonitorNotifyFilterAttachToVolumeEventArgs) SetResultCode(value int32)

// CBMonitorNotifyFilterAttachToVolumeEvent defines the signature of the CBMonitor NotifyFilterAttachToVolume event's handler function.
type CBMonitorNotifyFilterAttachToVolumeEvent func(sender *CBMonitor, args *CBMonitorNotifyFilterAttachToVolumeEventArgs)

func (obj *CBMonitor) GetOnNotifyFilterAttachToVolumeHandler() CBMonitorNotifyFilterAttachToVolumeEvent
func (obj *CBMonitor) SetOnNotifyFilterAttachToVolumeHandler(handlerFunc CBMonitorNotifyFilterAttachToVolumeEvent)

Remarks

This event fires when the filter has been attached to the newly mounted filesystem volume specified by VolumeNameNT and, when possible, VolumeName. Please refer to the FireVolumeEvents property for more information.

Applications need to handle this event only if the FireVolumeEvents property includes the FS_MOUNT_NOTIFY flag.

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

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

Applications that use volume-specific rules should typically add such rules during the AfterFilterAttachToVolume event, which is fired synchronously, rather than this one.

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

NotifyFilterDetachFromVolume Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyFilterDetachFromVolumeEventArgs carries the CBMonitor NotifyFilterDetachFromVolume event's parameters.
type CBMonitorNotifyFilterDetachFromVolumeEventArgs struct {...}

func (args *CBMonitorNotifyFilterDetachFromVolumeEventArgs) VolumeName() string
func (args *CBMonitorNotifyFilterDetachFromVolumeEventArgs) VolumeNameNT() string
func (args *CBMonitorNotifyFilterDetachFromVolumeEventArgs) ResultCode() int32
func (args *CBMonitorNotifyFilterDetachFromVolumeEventArgs) SetResultCode(value int32)

// CBMonitorNotifyFilterDetachFromVolumeEvent defines the signature of the CBMonitor NotifyFilterDetachFromVolume event's handler function.
type CBMonitorNotifyFilterDetachFromVolumeEvent func(sender *CBMonitor, args *CBMonitorNotifyFilterDetachFromVolumeEventArgs)

func (obj *CBMonitor) GetOnNotifyFilterDetachFromVolumeHandler() CBMonitorNotifyFilterDetachFromVolumeEvent
func (obj *CBMonitor) SetOnNotifyFilterDetachFromVolumeHandler(handlerFunc CBMonitorNotifyFilterDetachFromVolumeEvent)

Remarks

This event fires when the filter has been detached from the filesystem volume specified by VolumeNameNT and, when possible, VolumeName, typically as a result of the volume being unmounted. Please refer to the FireVolumeEvents property for more information.

Applications need to handle this event only if the FireVolumeEvents property includes the FS_MOUNT_NOTIFY flag.

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

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

Applications that use volume-specific rules typically should remove such rules during the AfterFilterDetachFromVolume event, which is fired synchronously, rather than this one.

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

NotifyFsctl Event (CBMonitor Component)

This event fires when an IRP_MJ_FILE_SYSTEM_CONTROL operation has occurred.

Syntax

// CBMonitorNotifyFsctlEventArgs carries the CBMonitor NotifyFsctl event's parameters.
type CBMonitorNotifyFsctlEventArgs struct {...}

func (args *CBMonitorNotifyFsctlEventArgs) FileName() string
func (args *CBMonitorNotifyFsctlEventArgs) FsControlCode() int32
func (args *CBMonitorNotifyFsctlEventArgs) InBuffer() []byte
func (args *CBMonitorNotifyFsctlEventArgs) InBufferLength() int32
func (args *CBMonitorNotifyFsctlEventArgs) InBufferValidBytes() int32
func (args *CBMonitorNotifyFsctlEventArgs) OutBuffer() []byte
func (args *CBMonitorNotifyFsctlEventArgs) OutBufferLength() int32
func (args *CBMonitorNotifyFsctlEventArgs) OutBufferValidBytes() int32
func (args *CBMonitorNotifyFsctlEventArgs) Status() int32
func (args *CBMonitorNotifyFsctlEventArgs) ResultCode() int32
func (args *CBMonitorNotifyFsctlEventArgs) SetResultCode(value int32)

// CBMonitorNotifyFsctlEvent defines the signature of the CBMonitor NotifyFsctl event's handler function.
type CBMonitorNotifyFsctlEvent func(sender *CBMonitor, args *CBMonitorNotifyFsctlEventArgs)

func (obj *CBMonitor) GetOnNotifyFsctlHandler() CBMonitorNotifyFsctlEvent
func (obj *CBMonitor) SetOnNotifyFsctlHandler(handlerFunc CBMonitorNotifyFsctlEvent)

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

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyGetFileSecurity Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyGetFileSecurityEventArgs carries the CBMonitor NotifyGetFileSecurity event's parameters.
type CBMonitorNotifyGetFileSecurityEventArgs struct {...}

func (args *CBMonitorNotifyGetFileSecurityEventArgs) FileName() string
func (args *CBMonitorNotifyGetFileSecurityEventArgs) SecurityInformation() int32
func (args *CBMonitorNotifyGetFileSecurityEventArgs) SecurityDescriptor() []byte
func (args *CBMonitorNotifyGetFileSecurityEventArgs) Length() int32
func (args *CBMonitorNotifyGetFileSecurityEventArgs) Status() int32
func (args *CBMonitorNotifyGetFileSecurityEventArgs) ResultCode() int32
func (args *CBMonitorNotifyGetFileSecurityEventArgs) SetResultCode(value int32)

// CBMonitorNotifyGetFileSecurityEvent defines the signature of the CBMonitor NotifyGetFileSecurity event's handler function.
type CBMonitorNotifyGetFileSecurityEvent func(sender *CBMonitor, args *CBMonitorNotifyGetFileSecurityEventArgs)

func (obj *CBMonitor) GetOnNotifyGetFileSecurityHandler() CBMonitorNotifyGetFileSecurityEvent
func (obj *CBMonitor) SetOnNotifyGetFileSecurityHandler(handlerFunc CBMonitorNotifyGetFileSecurityEvent)

Remarks

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

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

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyGetFileSizes Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyGetFileSizesEventArgs carries the CBMonitor NotifyGetFileSizes event's parameters.
type CBMonitorNotifyGetFileSizesEventArgs struct {...}

func (args *CBMonitorNotifyGetFileSizesEventArgs) FileName() string
func (args *CBMonitorNotifyGetFileSizesEventArgs) Size() int64
func (args *CBMonitorNotifyGetFileSizesEventArgs) AllocationSize() int64
func (args *CBMonitorNotifyGetFileSizesEventArgs) Status() int32
func (args *CBMonitorNotifyGetFileSizesEventArgs) ResultCode() int32
func (args *CBMonitorNotifyGetFileSizesEventArgs) SetResultCode(value int32)

// CBMonitorNotifyGetFileSizesEvent defines the signature of the CBMonitor NotifyGetFileSizes event's handler function.
type CBMonitorNotifyGetFileSizesEvent func(sender *CBMonitor, args *CBMonitorNotifyGetFileSizesEventArgs)

func (obj *CBMonitor) GetOnNotifyGetFileSizesHandler() CBMonitorNotifyGetFileSizesEvent
func (obj *CBMonitor) SetOnNotifyGetFileSizesHandler(handlerFunc CBMonitorNotifyGetFileSizesEvent)

Remarks

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

Applications 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyGetReparsePoint Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyGetReparsePointEventArgs carries the CBMonitor NotifyGetReparsePoint event's parameters.
type CBMonitorNotifyGetReparsePointEventArgs struct {...}

func (args *CBMonitorNotifyGetReparsePointEventArgs) FileName() string
func (args *CBMonitorNotifyGetReparsePointEventArgs) Status() int32
func (args *CBMonitorNotifyGetReparsePointEventArgs) ResultCode() int32
func (args *CBMonitorNotifyGetReparsePointEventArgs) SetResultCode(value int32)

// CBMonitorNotifyGetReparsePointEvent defines the signature of the CBMonitor NotifyGetReparsePoint event's handler function.
type CBMonitorNotifyGetReparsePointEvent func(sender *CBMonitor, args *CBMonitorNotifyGetReparsePointEventArgs)

func (obj *CBMonitor) GetOnNotifyGetReparsePointHandler() CBMonitorNotifyGetReparsePointEvent
func (obj *CBMonitor) SetOnNotifyGetReparsePointHandler(handlerFunc CBMonitorNotifyGetReparsePointEvent)

Remarks

This event fires when reparse point information has been retrieved for the file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyIoctl Event (CBMonitor Component)

This event fires when an IRP_MJ_DEVICE_CONTROL operation has occurred.

Syntax

// CBMonitorNotifyIoctlEventArgs carries the CBMonitor NotifyIoctl event's parameters.
type CBMonitorNotifyIoctlEventArgs struct {...}

func (args *CBMonitorNotifyIoctlEventArgs) FileName() string
func (args *CBMonitorNotifyIoctlEventArgs) IoControlCode() int32
func (args *CBMonitorNotifyIoctlEventArgs) InBuffer() []byte
func (args *CBMonitorNotifyIoctlEventArgs) InBufferLength() int32
func (args *CBMonitorNotifyIoctlEventArgs) InBufferValidBytes() int32
func (args *CBMonitorNotifyIoctlEventArgs) OutBuffer() []byte
func (args *CBMonitorNotifyIoctlEventArgs) OutBufferLength() int32
func (args *CBMonitorNotifyIoctlEventArgs) OutBufferValidBytes() int32
func (args *CBMonitorNotifyIoctlEventArgs) Status() int32
func (args *CBMonitorNotifyIoctlEventArgs) ResultCode() int32
func (args *CBMonitorNotifyIoctlEventArgs) SetResultCode(value int32)

// CBMonitorNotifyIoctlEvent defines the signature of the CBMonitor NotifyIoctl event's handler function.
type CBMonitorNotifyIoctlEvent func(sender *CBMonitor, args *CBMonitorNotifyIoctlEventArgs)

func (obj *CBMonitor) GetOnNotifyIoctlHandler() CBMonitorNotifyIoctlEvent
func (obj *CBMonitor) SetOnNotifyIoctlHandler(handlerFunc CBMonitorNotifyIoctlEvent)

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

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyLock Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyLockEventArgs carries the CBMonitor NotifyLock event's parameters.
type CBMonitorNotifyLockEventArgs struct {...}

func (args *CBMonitorNotifyLockEventArgs) FileName() string
func (args *CBMonitorNotifyLockEventArgs) Offset() int64
func (args *CBMonitorNotifyLockEventArgs) Length() int64
func (args *CBMonitorNotifyLockEventArgs) Key() int64
func (args *CBMonitorNotifyLockEventArgs) FailImmediately() bool
func (args *CBMonitorNotifyLockEventArgs) ExclusiveLock() bool
func (args *CBMonitorNotifyLockEventArgs) Status() int32
func (args *CBMonitorNotifyLockEventArgs) ResultCode() int32
func (args *CBMonitorNotifyLockEventArgs) SetResultCode(value int32)

// CBMonitorNotifyLockEvent defines the signature of the CBMonitor NotifyLock event's handler function.
type CBMonitorNotifyLockEvent func(sender *CBMonitor, args *CBMonitorNotifyLockEventArgs)

func (obj *CBMonitor) GetOnNotifyLockHandler() CBMonitorNotifyLockEvent
func (obj *CBMonitor) SetOnNotifyLockHandler(handlerFunc CBMonitorNotifyLockEvent)

Remarks

This event fires when a range of bytes in the file specified by FileName has been locked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This request is made either by the OS, or on behalf of a user mode application that called the Windows API's LockFile or LockFileEx function.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyOpenFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyOpenFileEventArgs carries the CBMonitor NotifyOpenFile event's parameters.
type CBMonitorNotifyOpenFileEventArgs struct {...}

func (args *CBMonitorNotifyOpenFileEventArgs) FileName() string
func (args *CBMonitorNotifyOpenFileEventArgs) ExistingAttributes() int32
func (args *CBMonitorNotifyOpenFileEventArgs) DesiredAccess() int32
func (args *CBMonitorNotifyOpenFileEventArgs) Attributes() int32
func (args *CBMonitorNotifyOpenFileEventArgs) ShareMode() int32
func (args *CBMonitorNotifyOpenFileEventArgs) Options() int32
func (args *CBMonitorNotifyOpenFileEventArgs) CreateDisposition() int32
func (args *CBMonitorNotifyOpenFileEventArgs) SecurityDescriptor() []byte
func (args *CBMonitorNotifyOpenFileEventArgs) Length() int32
func (args *CBMonitorNotifyOpenFileEventArgs) Status() int32
func (args *CBMonitorNotifyOpenFileEventArgs) CreationStatus() int32
func (args *CBMonitorNotifyOpenFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyOpenFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyOpenFileEvent defines the signature of the CBMonitor NotifyOpenFile event's handler function.
type CBMonitorNotifyOpenFileEvent func(sender *CBMonitor, args *CBMonitorNotifyOpenFileEventArgs)

func (obj *CBMonitor) GetOnNotifyOpenFileHandler() CBMonitorNotifyOpenFileEvent
func (obj *CBMonitor) SetOnNotifyOpenFileHandler(handlerFunc CBMonitorNotifyOpenFileEvent)

Remarks

This event fires when the file or directory specified by FileName has been opened. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. Please refer to the File Create/Open Events topic for more information about how the struct determines whether to fire this event or NotifyCreateFile.

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

If the file is opened with extended attributes passed in the request, the NotifySetEa 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 NtStatusToWin32Error method.

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

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

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

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

NotifyQueryEa Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyQueryEaEventArgs carries the CBMonitor NotifyQueryEa event's parameters.
type CBMonitorNotifyQueryEaEventArgs struct {...}

func (args *CBMonitorNotifyQueryEaEventArgs) FileName() string
func (args *CBMonitorNotifyQueryEaEventArgs) Buffer() []byte
func (args *CBMonitorNotifyQueryEaEventArgs) BufferLength() int32
func (args *CBMonitorNotifyQueryEaEventArgs) ReturnSingleEntry() bool
func (args *CBMonitorNotifyQueryEaEventArgs) EaList() []byte
func (args *CBMonitorNotifyQueryEaEventArgs) EaListLength() int32
func (args *CBMonitorNotifyQueryEaEventArgs) EaIndex() int32
func (args *CBMonitorNotifyQueryEaEventArgs) RestartScan() bool
func (args *CBMonitorNotifyQueryEaEventArgs) LengthReturned() int32
func (args *CBMonitorNotifyQueryEaEventArgs) Status() int32
func (args *CBMonitorNotifyQueryEaEventArgs) ResultCode() int32
func (args *CBMonitorNotifyQueryEaEventArgs) SetResultCode(value int32)

// CBMonitorNotifyQueryEaEvent defines the signature of the CBMonitor NotifyQueryEa event's handler function.
type CBMonitorNotifyQueryEaEvent func(sender *CBMonitor, args *CBMonitorNotifyQueryEaEventArgs)

func (obj *CBMonitor) GetOnNotifyQueryEaHandler() CBMonitorNotifyQueryEaEvent
func (obj *CBMonitor) SetOnNotifyQueryEaHandler(handlerFunc CBMonitorNotifyQueryEaEvent)

Remarks

This event fires when information about the extended attributes of a file specified by FileName has been retrieved. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyQueryFileInfo Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyQueryFileInfoEventArgs carries the CBMonitor NotifyQueryFileInfo event's parameters.
type CBMonitorNotifyQueryFileInfoEventArgs struct {...}

func (args *CBMonitorNotifyQueryFileInfoEventArgs) FileName() string
func (args *CBMonitorNotifyQueryFileInfoEventArgs) FileInformationClass() int32
func (args *CBMonitorNotifyQueryFileInfoEventArgs) Buffer() []byte
func (args *CBMonitorNotifyQueryFileInfoEventArgs) BufferLength() int32
func (args *CBMonitorNotifyQueryFileInfoEventArgs) ValidBytes() int32
func (args *CBMonitorNotifyQueryFileInfoEventArgs) Status() int32
func (args *CBMonitorNotifyQueryFileInfoEventArgs) ResultCode() int32
func (args *CBMonitorNotifyQueryFileInfoEventArgs) SetResultCode(value int32)

// CBMonitorNotifyQueryFileInfoEvent defines the signature of the CBMonitor NotifyQueryFileInfo event's handler function.
type CBMonitorNotifyQueryFileInfoEvent func(sender *CBMonitor, args *CBMonitorNotifyQueryFileInfoEventArgs)

func (obj *CBMonitor) GetOnNotifyQueryFileInfoHandler() CBMonitorNotifyQueryFileInfoEvent
func (obj *CBMonitor) SetOnNotifyQueryFileInfoHandler(handlerFunc CBMonitorNotifyQueryFileInfoEvent)

Remarks

This event fires when information about a file or directory specified by FileName has been retrieved. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event typically fires in response to the Windows API's NtQueryInformationFile function.

Applications 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyReadFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyReadFileEventArgs carries the CBMonitor NotifyReadFile event's parameters.
type CBMonitorNotifyReadFileEventArgs struct {...}

func (args *CBMonitorNotifyReadFileEventArgs) FileName() string
func (args *CBMonitorNotifyReadFileEventArgs) Position() int64
func (args *CBMonitorNotifyReadFileEventArgs) BytesToRead() int32
func (args *CBMonitorNotifyReadFileEventArgs) Direction() int32
func (args *CBMonitorNotifyReadFileEventArgs) BytesRead() int32
func (args *CBMonitorNotifyReadFileEventArgs) Status() int32
func (args *CBMonitorNotifyReadFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyReadFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyReadFileEvent defines the signature of the CBMonitor NotifyReadFile event's handler function.
type CBMonitorNotifyReadFileEvent func(sender *CBMonitor, args *CBMonitorNotifyReadFileEventArgs)

func (obj *CBMonitor) GetOnNotifyReadFileHandler() CBMonitorNotifyReadFileEvent
func (obj *CBMonitor) SetOnNotifyReadFileHandler(handlerFunc CBMonitorNotifyReadFileEvent)

Remarks

This event fires when data have been read from a file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyRenameOrMoveFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyRenameOrMoveFileEventArgs carries the CBMonitor NotifyRenameOrMoveFile event's parameters.
type CBMonitorNotifyRenameOrMoveFileEventArgs struct {...}

func (args *CBMonitorNotifyRenameOrMoveFileEventArgs) FileName() string
func (args *CBMonitorNotifyRenameOrMoveFileEventArgs) NewFileName() string
func (args *CBMonitorNotifyRenameOrMoveFileEventArgs) Status() int32
func (args *CBMonitorNotifyRenameOrMoveFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyRenameOrMoveFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyRenameOrMoveFileEvent defines the signature of the CBMonitor NotifyRenameOrMoveFile event's handler function.
type CBMonitorNotifyRenameOrMoveFileEvent func(sender *CBMonitor, args *CBMonitorNotifyRenameOrMoveFileEventArgs)

func (obj *CBMonitor) GetOnNotifyRenameOrMoveFileHandler() CBMonitorNotifyRenameOrMoveFileEvent
func (obj *CBMonitor) SetOnNotifyRenameOrMoveFileHandler(handlerFunc CBMonitorNotifyRenameOrMoveFileEvent)

Remarks

This event fires when a file or directory specified by FileName has been renamed or moved to NewFileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

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

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

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetAllocationSize Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifySetAllocationSizeEventArgs carries the CBMonitor NotifySetAllocationSize event's parameters.
type CBMonitorNotifySetAllocationSizeEventArgs struct {...}

func (args *CBMonitorNotifySetAllocationSizeEventArgs) FileName() string
func (args *CBMonitorNotifySetAllocationSizeEventArgs) AllocationSize() int64
func (args *CBMonitorNotifySetAllocationSizeEventArgs) Status() int32
func (args *CBMonitorNotifySetAllocationSizeEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetAllocationSizeEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetAllocationSizeEvent defines the signature of the CBMonitor NotifySetAllocationSize event's handler function.
type CBMonitorNotifySetAllocationSizeEvent func(sender *CBMonitor, args *CBMonitorNotifySetAllocationSizeEventArgs)

func (obj *CBMonitor) GetOnNotifySetAllocationSizeHandler() CBMonitorNotifySetAllocationSizeEvent
func (obj *CBMonitor) SetOnNotifySetAllocationSizeHandler(handlerFunc CBMonitorNotifySetAllocationSizeEvent)

Remarks

This event fires when the allocation size of the file specified by FileName has been changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetEa Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifySetEaEventArgs carries the CBMonitor NotifySetEa event's parameters.
type CBMonitorNotifySetEaEventArgs struct {...}

func (args *CBMonitorNotifySetEaEventArgs) FileName() string
func (args *CBMonitorNotifySetEaEventArgs) Buffer() []byte
func (args *CBMonitorNotifySetEaEventArgs) BufferLength() int32
func (args *CBMonitorNotifySetEaEventArgs) Status() int32
func (args *CBMonitorNotifySetEaEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetEaEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetEaEvent defines the signature of the CBMonitor NotifySetEa event's handler function.
type CBMonitorNotifySetEaEvent func(sender *CBMonitor, args *CBMonitorNotifySetEaEventArgs)

func (obj *CBMonitor) GetOnNotifySetEaHandler() CBMonitorNotifySetEaEvent
func (obj *CBMonitor) SetOnNotifySetEaHandler(handlerFunc CBMonitorNotifySetEaEvent)

Remarks

This event fires when information about the extended attributes of a file specified by FileName has been changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

If the file is created or opened with extended attributes passed in the request, this event will fire shortly after the NotifyCreateFile or NotifyOpenFile 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetFileAttributes Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifySetFileAttributesEventArgs carries the CBMonitor NotifySetFileAttributes event's parameters.
type CBMonitorNotifySetFileAttributesEventArgs struct {...}

func (args *CBMonitorNotifySetFileAttributesEventArgs) FileName() string
func (args *CBMonitorNotifySetFileAttributesEventArgs) CreationTime() time.Time
func (args *CBMonitorNotifySetFileAttributesEventArgs) LastAccessTime() time.Time
func (args *CBMonitorNotifySetFileAttributesEventArgs) LastWriteTime() time.Time
func (args *CBMonitorNotifySetFileAttributesEventArgs) ChangeTime() time.Time
func (args *CBMonitorNotifySetFileAttributesEventArgs) Attributes() int32
func (args *CBMonitorNotifySetFileAttributesEventArgs) Status() int32
func (args *CBMonitorNotifySetFileAttributesEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetFileAttributesEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetFileAttributesEvent defines the signature of the CBMonitor NotifySetFileAttributes event's handler function.
type CBMonitorNotifySetFileAttributesEvent func(sender *CBMonitor, args *CBMonitorNotifySetFileAttributesEventArgs)

func (obj *CBMonitor) GetOnNotifySetFileAttributesHandler() CBMonitorNotifySetFileAttributesEvent
func (obj *CBMonitor) SetOnNotifySetFileAttributesHandler(handlerFunc CBMonitorNotifySetFileAttributesEvent)

Remarks

This event fires when the attributes or times of the file or directory specified by FileName have been changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetFileInfo Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifySetFileInfoEventArgs carries the CBMonitor NotifySetFileInfo event's parameters.
type CBMonitorNotifySetFileInfoEventArgs struct {...}

func (args *CBMonitorNotifySetFileInfoEventArgs) FileName() string
func (args *CBMonitorNotifySetFileInfoEventArgs) FileInformationClass() int32
func (args *CBMonitorNotifySetFileInfoEventArgs) Buffer() []byte
func (args *CBMonitorNotifySetFileInfoEventArgs) BufferLength() int32
func (args *CBMonitorNotifySetFileInfoEventArgs) ValidBytes() int32
func (args *CBMonitorNotifySetFileInfoEventArgs) Status() int32
func (args *CBMonitorNotifySetFileInfoEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetFileInfoEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetFileInfoEvent defines the signature of the CBMonitor NotifySetFileInfo event's handler function.
type CBMonitorNotifySetFileInfoEvent func(sender *CBMonitor, args *CBMonitorNotifySetFileInfoEventArgs)

func (obj *CBMonitor) GetOnNotifySetFileInfoHandler() CBMonitorNotifySetFileInfoEvent
func (obj *CBMonitor) SetOnNotifySetFileInfoHandler(handlerFunc CBMonitorNotifySetFileInfoEvent)

Remarks

This event fires when information about a file or directory specified by FileName has been changed. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic. This event typically fires in response to the Windows API's NtSetInformationFile function.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetFileSecurity Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifySetFileSecurityEventArgs carries the CBMonitor NotifySetFileSecurity event's parameters.
type CBMonitorNotifySetFileSecurityEventArgs struct {...}

func (args *CBMonitorNotifySetFileSecurityEventArgs) FileName() string
func (args *CBMonitorNotifySetFileSecurityEventArgs) SecurityInformation() int32
func (args *CBMonitorNotifySetFileSecurityEventArgs) SecurityDescriptor() []byte
func (args *CBMonitorNotifySetFileSecurityEventArgs) Length() int32
func (args *CBMonitorNotifySetFileSecurityEventArgs) Status() int32
func (args *CBMonitorNotifySetFileSecurityEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetFileSecurityEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetFileSecurityEvent defines the signature of the CBMonitor NotifySetFileSecurity event's handler function.
type CBMonitorNotifySetFileSecurityEvent func(sender *CBMonitor, args *CBMonitorNotifySetFileSecurityEventArgs)

func (obj *CBMonitor) GetOnNotifySetFileSecurityHandler() CBMonitorNotifySetFileSecurityEvent
func (obj *CBMonitor) SetOnNotifySetFileSecurityHandler(handlerFunc CBMonitorNotifySetFileSecurityEvent)

Remarks

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

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetFileSize Event (CBMonitor Component)

This event fires when a file has been resized.

Syntax

// CBMonitorNotifySetFileSizeEventArgs carries the CBMonitor NotifySetFileSize event's parameters.
type CBMonitorNotifySetFileSizeEventArgs struct {...}

func (args *CBMonitorNotifySetFileSizeEventArgs) FileName() string
func (args *CBMonitorNotifySetFileSizeEventArgs) Size() int64
func (args *CBMonitorNotifySetFileSizeEventArgs) Status() int32
func (args *CBMonitorNotifySetFileSizeEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetFileSizeEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetFileSizeEvent defines the signature of the CBMonitor NotifySetFileSize event's handler function.
type CBMonitorNotifySetFileSizeEvent func(sender *CBMonitor, args *CBMonitorNotifySetFileSizeEventArgs)

func (obj *CBMonitor) GetOnNotifySetFileSizeHandler() CBMonitorNotifySetFileSizeEvent
func (obj *CBMonitor) SetOnNotifySetFileSizeHandler(handlerFunc CBMonitorNotifySetFileSizeEvent)

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). For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifySetReparsePoint Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifySetReparsePointEventArgs carries the CBMonitor NotifySetReparsePoint event's parameters.
type CBMonitorNotifySetReparsePointEventArgs struct {...}

func (args *CBMonitorNotifySetReparsePointEventArgs) FileName() string
func (args *CBMonitorNotifySetReparsePointEventArgs) ReparseTag() int64
func (args *CBMonitorNotifySetReparsePointEventArgs) Status() int32
func (args *CBMonitorNotifySetReparsePointEventArgs) ResultCode() int32
func (args *CBMonitorNotifySetReparsePointEventArgs) SetResultCode(value int32)

// CBMonitorNotifySetReparsePointEvent defines the signature of the CBMonitor NotifySetReparsePoint event's handler function.
type CBMonitorNotifySetReparsePointEvent func(sender *CBMonitor, args *CBMonitorNotifySetReparsePointEventArgs)

func (obj *CBMonitor) GetOnNotifySetReparsePointHandler() CBMonitorNotifySetReparsePointEvent
func (obj *CBMonitor) SetOnNotifySetReparsePointHandler(handlerFunc CBMonitorNotifySetReparsePointEvent)

Remarks

This event fires when a reparse point has been created or updated for a file or directory specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyUnlockAll Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyUnlockAllEventArgs carries the CBMonitor NotifyUnlockAll event's parameters.
type CBMonitorNotifyUnlockAllEventArgs struct {...}

func (args *CBMonitorNotifyUnlockAllEventArgs) FileName() string
func (args *CBMonitorNotifyUnlockAllEventArgs) Status() int32
func (args *CBMonitorNotifyUnlockAllEventArgs) ResultCode() int32
func (args *CBMonitorNotifyUnlockAllEventArgs) SetResultCode(value int32)

// CBMonitorNotifyUnlockAllEvent defines the signature of the CBMonitor NotifyUnlockAll event's handler function.
type CBMonitorNotifyUnlockAllEvent func(sender *CBMonitor, args *CBMonitorNotifyUnlockAllEventArgs)

func (obj *CBMonitor) GetOnNotifyUnlockAllHandler() CBMonitorNotifyUnlockAllEvent
func (obj *CBMonitor) SetOnNotifyUnlockAllHandler(handlerFunc CBMonitorNotifyUnlockAllEvent)

Remarks

This event fires when all locked byte ranges in the file specified by FileName have been unlocked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyUnlockAllByKey Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyUnlockAllByKeyEventArgs carries the CBMonitor NotifyUnlockAllByKey event's parameters.
type CBMonitorNotifyUnlockAllByKeyEventArgs struct {...}

func (args *CBMonitorNotifyUnlockAllByKeyEventArgs) FileName() string
func (args *CBMonitorNotifyUnlockAllByKeyEventArgs) Key() int64
func (args *CBMonitorNotifyUnlockAllByKeyEventArgs) Status() int32
func (args *CBMonitorNotifyUnlockAllByKeyEventArgs) ResultCode() int32
func (args *CBMonitorNotifyUnlockAllByKeyEventArgs) SetResultCode(value int32)

// CBMonitorNotifyUnlockAllByKeyEvent defines the signature of the CBMonitor NotifyUnlockAllByKey event's handler function.
type CBMonitorNotifyUnlockAllByKeyEvent func(sender *CBMonitor, args *CBMonitorNotifyUnlockAllByKeyEventArgs)

func (obj *CBMonitor) GetOnNotifyUnlockAllByKeyHandler() CBMonitorNotifyUnlockAllByKeyEvent
func (obj *CBMonitor) SetOnNotifyUnlockAllByKeyHandler(handlerFunc CBMonitorNotifyUnlockAllByKeyEvent)

Remarks

This event fires when all locked byte ranges in the file specified by FileName, and associated with the specified Key, have been unlocked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

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

The Key parameter contains the key value specified when the byte ranges were locked. Please refer to the NotifyLock 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyUnlockSingle Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyUnlockSingleEventArgs carries the CBMonitor NotifyUnlockSingle event's parameters.
type CBMonitorNotifyUnlockSingleEventArgs struct {...}

func (args *CBMonitorNotifyUnlockSingleEventArgs) FileName() string
func (args *CBMonitorNotifyUnlockSingleEventArgs) Offset() int64
func (args *CBMonitorNotifyUnlockSingleEventArgs) Length() int64
func (args *CBMonitorNotifyUnlockSingleEventArgs) Key() int64
func (args *CBMonitorNotifyUnlockSingleEventArgs) Status() int32
func (args *CBMonitorNotifyUnlockSingleEventArgs) ResultCode() int32
func (args *CBMonitorNotifyUnlockSingleEventArgs) SetResultCode(value int32)

// CBMonitorNotifyUnlockSingleEvent defines the signature of the CBMonitor NotifyUnlockSingle event's handler function.
type CBMonitorNotifyUnlockSingleEvent func(sender *CBMonitor, args *CBMonitorNotifyUnlockSingleEventArgs)

func (obj *CBMonitor) GetOnNotifyUnlockSingleHandler() CBMonitorNotifyUnlockSingleEvent
func (obj *CBMonitor) SetOnNotifyUnlockSingleHandler(handlerFunc CBMonitorNotifyUnlockSingleEvent)

Remarks

This event fires when a particular locked byte range in a file specified by FileName has been unlocked. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications need to handle this event only if they have added a standard filter rule that includes the FS_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 NotifyLock 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

NotifyWriteFile Event (CBMonitor Component)

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

Syntax

// CBMonitorNotifyWriteFileEventArgs carries the CBMonitor NotifyWriteFile event's parameters.
type CBMonitorNotifyWriteFileEventArgs struct {...}

func (args *CBMonitorNotifyWriteFileEventArgs) FileName() string
func (args *CBMonitorNotifyWriteFileEventArgs) Position() int64
func (args *CBMonitorNotifyWriteFileEventArgs) BytesToWrite() int32
func (args *CBMonitorNotifyWriteFileEventArgs) Direction() int32
func (args *CBMonitorNotifyWriteFileEventArgs) BytesWritten() int32
func (args *CBMonitorNotifyWriteFileEventArgs) Status() int32
func (args *CBMonitorNotifyWriteFileEventArgs) ResultCode() int32
func (args *CBMonitorNotifyWriteFileEventArgs) SetResultCode(value int32)

// CBMonitorNotifyWriteFileEvent defines the signature of the CBMonitor NotifyWriteFile event's handler function.
type CBMonitorNotifyWriteFileEvent func(sender *CBMonitor, args *CBMonitorNotifyWriteFileEventArgs)

func (obj *CBMonitor) GetOnNotifyWriteFileHandler() CBMonitorNotifyWriteFileEvent
func (obj *CBMonitor) SetOnNotifyWriteFileHandler(handlerFunc CBMonitorNotifyWriteFileEvent)

Remarks

This event fires when data have been written to the file specified by FileName. For more information about the FileName parameter and what it may contain, please refer to the Filenames In Events topic.

Applications 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 NtStatusToWin32Error method.

Note: This event will not fire for failed requests unless the ProcessFailedRequests 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 Handling topic for more information.

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

WorkerThreadCreation Event (CBMonitor Component)

Fires just after a new worker thread is created.

Syntax

// CBMonitorWorkerThreadCreationEventArgs carries the CBMonitor WorkerThreadCreation event's parameters.
type CBMonitorWorkerThreadCreationEventArgs struct {...}

func (args *CBMonitorWorkerThreadCreationEventArgs) ResultCode() int32
func (args *CBMonitorWorkerThreadCreationEventArgs) SetResultCode(value int32)

// CBMonitorWorkerThreadCreationEvent defines the signature of the CBMonitor WorkerThreadCreation event's handler function.
type CBMonitorWorkerThreadCreationEvent func(sender *CBMonitor, args *CBMonitorWorkerThreadCreationEventArgs)

func (obj *CBMonitor) GetOnWorkerThreadCreationHandler() CBMonitorWorkerThreadCreationEvent
func (obj *CBMonitor) SetOnWorkerThreadCreationHandler(handlerFunc CBMonitorWorkerThreadCreationEvent)

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

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

WorkerThreadTermination Event (CBMonitor Component)

Fires just before a worker thread is terminated.

Syntax

// CBMonitorWorkerThreadTerminationEventArgs carries the CBMonitor WorkerThreadTermination event's parameters.
type CBMonitorWorkerThreadTerminationEventArgs struct {...}

// CBMonitorWorkerThreadTerminationEvent defines the signature of the CBMonitor WorkerThreadTermination event's handler function.
type CBMonitorWorkerThreadTerminationEvent func(sender *CBMonitor, args *CBMonitorWorkerThreadTerminationEventArgs)

func (obj *CBMonitor) GetOnWorkerThreadTerminationHandler() CBMonitorWorkerThreadTerminationEvent
func (obj *CBMonitor) SetOnWorkerThreadTerminationHandler(handlerFunc CBMonitorWorkerThreadTerminationEvent)

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

Config Settings (CBMonitor Component)

The struct 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 struct, access to these internal properties is provided through the Config method.

CBMonitor Config Settings

Base Config Settings

Trappable Errors (CBMonitor Component)

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

Special Use Errors