CBMonitor Component

Properties   Methods   Events   Config Settings   Errors  

The CBMonitor component allows applications to monitor filesystem requests.

Syntax

callback.CBFSFilter.CBMonitor

Remarks

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

Getting Started

1. If the component'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 component. 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 component'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 component is active and processing requests.

Syntax

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

Default Value

False

Remarks

This property reflects whether the component 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 and not available at design time.

Altitude Property (CBMonitor Component)

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

Syntax

• C#
• VB.NET

public string Altitude { get; set; }

Public Property Altitude As String

Default Value

""

Remarks

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

FilterRules Property (CBMonitor Component)

This property includes a collection of filter rules.

Syntax

• C#
• VB.NET

public FileFilterRuleList FilterRules { get; }

Public ReadOnly Property FilterRules As FileFilterRuleList

Remarks

This property holds a collection of FileFilterRule objects, each of which represents a standard filter rule, access rule, or both. Please refer to the File and Registry Filter Rules and Access Rules topics for more information.

Use the following methods to manage the rules in this collection:

• AddFilterRule
• AddFilterRuleEx
• DeleteFilterRule
• DeleteAllFilterRules

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.

This property is read-only and not available at design time.

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

• C#
• VB.NET

public int FireVolumeEvents { get; set; }

Public Property FireVolumeEvents As Integer

Default Value

0

Remarks

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

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

• C#
• VB.NET

public int NormalizeShortFileNames { get; set; }

Public Property NormalizeShortFileNames As Integer

Default Value

0

Remarks

TBD.

PassthroughRules Property (CBMonitor Component)

This property includes a collection of passthrough rules.

Syntax

• C#
• VB.NET

public FilePassthroughRuleList PassthroughRules { get; }

Public ReadOnly Property PassthroughRules As FilePassthroughRuleList

Remarks

This property holds a collection of FilePassthroughRule objects, each of which represents a passthrough rule. Please refer to the Passthrough Rules topic for more information.

Use the following methods to manage the rules in this collection:

• AddPassthroughRule
• AddPassthroughRuleEx
• DeletePassthroughRule
• DeleteAllPassthroughRules

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.

This property is read-only and not available at design time.

ProcessCachedIORequests Property (CBMonitor Component)

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

Syntax

• C#
• VB.NET

public bool ProcessCachedIORequests { get; set; }

Public Property ProcessCachedIORequests As Boolean

Default Value

False

Remarks

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

ProcessFailedRequests Property (CBMonitor Component)

This property specifies whether failed requests should be processed.

Syntax

• C#
• VB.NET

public bool ProcessFailedRequests { get; set; }

Public Property ProcessFailedRequests As Boolean

Default Value

False

Remarks

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

SerializeEvents Property (CBMonitor Component)

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

Syntax

• C#
• VB.NET

public CBMonitorSerializeEvents SerializeEvents { get; set; }

enum CBMonitorSerializeEvents {
  seOnMultipleThreads,
  seOnOneWorkerThread
}

Public Property SerializeEvents As CbmonitorSerializeEvents

Enum CBMonitorSerializeEvents
  seOnMultipleThreads
  seOnOneWorkerThread
End Enum

Default Value

0

Remarks

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

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

Note: This property cannot be changed when Active is true, and it cannot be changed within events.

Tag Property (CBMonitor Component)

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

Syntax

• C#
• VB.NET

public long Tag { get; set; }

Public Property Tag As Long

Default Value

0

Remarks

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

AddFilterRule Method (CBMonitor Component)

This method adds a standard filter rule.

Syntax

• C#
• VB.NET

public bool AddFilterRule(string mask, long notifyFlags);

Public Function AddFilterRule(ByVal Mask As String, ByVal NotifyFlags As Long) As Boolean

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

• C#
• VB.NET

public bool AddFilterRuleEx(string mask, string eaName, long notifyFlags, long minSize, long maxSize, long includedAttributes, long excludedAttributes);

Public Function AddFilterRuleEx(ByVal Mask As String, ByVal EaName As String, ByVal NotifyFlags As Long, ByVal MinSize As Long, ByVal MaxSize As Long, ByVal IncludedAttributes As Long, ByVal ExcludedAttributes As Long) As Boolean

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

• C#
• VB.NET

public bool AddPassthroughRule(string mask, long notifyFlags);

Public Function AddPassthroughRule(ByVal Mask As String, ByVal NotifyFlags As Long) As Boolean

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

• C#
• VB.NET

public bool AddPassthroughRuleEx(string mask, string eaName, long notifyFlags, long minSize, long maxSize, long includedAttributes, long excludedAttributes);

Public Function AddPassthroughRuleEx(ByVal Mask As String, ByVal EaName As String, ByVal NotifyFlags As Long, ByVal MinSize As Long, ByVal MaxSize As Long, ByVal IncludedAttributes As Long, ByVal ExcludedAttributes As Long) As Boolean

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

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

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

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

• C#
• VB.NET

public bool DeleteAllFilterRules();

Public Function DeleteAllFilterRules() As Boolean

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

• C#
• VB.NET

public bool DeleteAllPassthroughRules();

Public Function DeleteAllPassthroughRules() As Boolean

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

• C#
• VB.NET

public bool DeleteFilterRule(string mask, long notifyFlags);

Public Function DeleteFilterRule(ByVal Mask As String, ByVal NotifyFlags As Long) As Boolean

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

• C#
• VB.NET

public bool DeletePassthroughRule(string mask, long notifyFlags);

Public Function DeletePassthroughRule(ByVal Mask As String, ByVal NotifyFlags As Long) As Boolean

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

• C#
• VB.NET

public bool FileMatchesMask(string mask, string fileName, bool caseSensitive);

Public Function FileMatchesMask(ByVal Mask As String, ByVal FileName As String, ByVal CaseSensitive As Boolean) As Boolean

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

• C#
• VB.NET

public string GetDOSPathName(string NTPath);

Public Function GetDOSPathName(ByVal NTPath As String) As String

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 component's system driver.

Syntax

• C#
• VB.NET

public int GetDriverStatus(string productGUID);

Public Function GetDriverStatus(ByVal ProductGUID As String) As Integer

Remarks

This method retrieves the status of the component'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 component 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 component's system driver.

Syntax

• C#
• VB.NET

public long GetDriverVersion(string productGUID);

Public Function GetDriverVersion(ByVal ProductGUID As String) As Long

Remarks

This method retrieves the version of the component'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 component'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 component 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

• C#
• VB.NET

public string GetEventFileName();

Public Function GetEventFileName() As String

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

• C#
• VB.NET

public string GetNTPathName(string DOSPath);

Public Function GetNTPathName(ByVal DOSPath As String) As String

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

• C#
• VB.NET

public DateTime GetOperationTime();

Public Function GetOperationTime() As DateTime

Remarks

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

The timestamps returned by this method are specified in UTC.

GetOriginatorProcessId Method (CBMonitor Component)

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

Syntax

• C#
• VB.NET

public int GetOriginatorProcessId();

Public Function GetOriginatorProcessId() As Integer

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.

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

• C#
• VB.NET

public string GetOriginatorProcessName();

Public Function GetOriginatorProcessName() As String

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.

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

• C#
• VB.NET

public int GetOriginatorThreadId();

Public Function GetOriginatorThreadId() As Integer

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.

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

• C#
• VB.NET

public void GetRemoteAccessInformation(ref string shareName, IntPtr clientSocketAddressBuffer, ref int clientSocketAddressBufferSize);

Public Sub GetRemoteAccessInformation(ByRef ShareName As String, ByVal ClientSocketAddressBuffer As IntPtr, ByRef ClientSocketAddressBufferSize As Integer)

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

• C#
• VB.NET

public string GetVolumeGUID();

Public Function GetVolumeGUID() As String

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

Syntax

• C#
• VB.NET

public void Initialize(string productGUID);

Public Sub Initialize(ByVal ProductGUID As String)

Remarks

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

Install Method (CBMonitor Component)

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

Syntax

• C#
• VB.NET

public bool Install(string cabFileName, string productGUID, string pathToInstall, string altitude, int flags, string allowedControllers);

Public Function Install(ByVal CabFileName As String, ByVal ProductGUID As String, ByVal PathToInstall As String, ByVal Altitude As String, ByVal Flags As Integer, ByVal AllowedControllers As String) As Boolean

Remarks

This method is used to install or upgrade the component'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 component'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 component'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 component 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

• C#
• VB.NET

public int NtStatusToWin32Error(int status);

Public Function NtStatusToWin32Error(ByVal Status As Integer) As Integer

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

• C#
• VB.NET

public bool ShutdownSystem(string shutdownPrompt, int timeout, bool forceCloseApps, bool reboot);

Public Function ShutdownSystem(ByVal ShutdownPrompt As String, ByVal Timeout As Integer, ByVal ForceCloseApps As Boolean, ByVal Reboot As Boolean) As Boolean

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

• C#
• VB.NET

public void StartFilter();

Public Sub StartFilter()

Remarks

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

• C#
• VB.NET

public void StopFilter();

Public Sub StopFilter()

Remarks

This method detaches the filter, causing the component'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 component's system driver.

Syntax

• C#
• VB.NET

public bool Uninstall(string cabFileName, string productGUID, string installedPath, int flags);

Public Function Uninstall(ByVal CabFileName As String, ByVal ProductGUID As String, ByVal InstalledPath As String, ByVal Flags As Integer) As Boolean

Remarks

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

• C#
• VB.NET

public event OnAfterFilterAttachToVolumeHandler OnAfterFilterAttachToVolume;

public delegate void OnAfterFilterAttachToVolumeHandler(object sender, CBMonitorAfterFilterAttachToVolumeEventArgs e);

public class CBMonitorAfterFilterAttachToVolumeEventArgs : EventArgs {
  public string VolumeName { get; }
  public string VolumeNameNT { get; }
  public int ResultCode { get; set; }
}

Public Event OnAfterFilterAttachToVolume As OnAfterFilterAttachToVolumeHandler

Public Delegate Sub OnAfterFilterAttachToVolumeHandler(sender As Object, e As CBMonitorAfterFilterAttachToVolumeEventArgs)

Public Class CBMonitorAfterFilterAttachToVolumeEventArgs Inherits EventArgs
  Public ReadOnly Property VolumeName As String
  Public ReadOnly Property VolumeNameNT As String
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnAfterFilterDetachFromVolumeHandler OnAfterFilterDetachFromVolume;

public delegate void OnAfterFilterDetachFromVolumeHandler(object sender, CBMonitorAfterFilterDetachFromVolumeEventArgs e);

public class CBMonitorAfterFilterDetachFromVolumeEventArgs : EventArgs {
  public string VolumeName { get; }
  public string VolumeNameNT { get; }
  public int ResultCode { get; set; }
}

Public Event OnAfterFilterDetachFromVolume As OnAfterFilterDetachFromVolumeHandler

Public Delegate Sub OnAfterFilterDetachFromVolumeHandler(sender As Object, e As CBMonitorAfterFilterDetachFromVolumeEventArgs)

Public Class CBMonitorAfterFilterDetachFromVolumeEventArgs Inherits EventArgs
  Public ReadOnly Property VolumeName As String
  Public ReadOnly Property VolumeNameNT As String
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnBeforeFilterAttachToVolumeHandler OnBeforeFilterAttachToVolume;

public delegate void OnBeforeFilterAttachToVolumeHandler(object sender, CBMonitorBeforeFilterAttachToVolumeEventArgs e);

public class CBMonitorBeforeFilterAttachToVolumeEventArgs : EventArgs {
  public string VolumeName { get; }
  public string VolumeNameNT { get; }
  public bool SkipVolume { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnBeforeFilterAttachToVolume As OnBeforeFilterAttachToVolumeHandler

Public Delegate Sub OnBeforeFilterAttachToVolumeHandler(sender As Object, e As CBMonitorBeforeFilterAttachToVolumeEventArgs)

Public Class CBMonitorBeforeFilterAttachToVolumeEventArgs Inherits EventArgs
  Public ReadOnly Property VolumeName As String
  Public ReadOnly Property VolumeNameNT As String
  Public Property SkipVolume As Boolean
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnBypassIORequestHandler OnBypassIORequest;

public delegate void OnBypassIORequestHandler(object sender, CBMonitorBypassIORequestEventArgs e);

public class CBMonitorBypassIORequestEventArgs : EventArgs {
  public string FileName { get; }
  public int RequestCode { get; }
  public int Status { get; set; }
  public string Reason { get; set; }
}

Public Event OnBypassIORequest As OnBypassIORequestHandler

Public Delegate Sub OnBypassIORequestHandler(sender As Object, e As CBMonitorBypassIORequestEventArgs)

Public Class CBMonitorBypassIORequestEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property RequestCode As Integer
  Public Property Status As Integer
  Public Property Reason As String
End Class

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 component. To ensure all future operations on the file are visible to the component 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 component 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

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, CBMonitorErrorEventArgs e);

public class CBMonitorErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As CBMonitorErrorEventArgs)

Public Class CBMonitorErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

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

• C#
• VB.NET

public event OnFilterStartHandler OnFilterStart;

public delegate void OnFilterStartHandler(object sender, CBMonitorFilterStartEventArgs e);

public class CBMonitorFilterStartEventArgs : EventArgs {
  public int ResultCode { get; set; }
}

Public Event OnFilterStart As OnFilterStartHandler

Public Delegate Sub OnFilterStartHandler(sender As Object, e As CBMonitorFilterStartEventArgs)

Public Class CBMonitorFilterStartEventArgs Inherits EventArgs
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnFilterStopHandler OnFilterStop;

public delegate void OnFilterStopHandler(object sender, CBMonitorFilterStopEventArgs e);

public class CBMonitorFilterStopEventArgs : EventArgs {
  public int ResultCode { get; set; }
}

Public Event OnFilterStop As OnFilterStopHandler

Public Delegate Sub OnFilterStopHandler(sender As Object, e As CBMonitorFilterStopEventArgs)

Public Class CBMonitorFilterStopEventArgs Inherits EventArgs
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyCanFileBeDeletedHandler OnNotifyCanFileBeDeleted;

public delegate void OnNotifyCanFileBeDeletedHandler(object sender, CBMonitorNotifyCanFileBeDeletedEventArgs e);

public class CBMonitorNotifyCanFileBeDeletedEventArgs : EventArgs {
  public string FileName { get; }
  public int RequestType { get; }
  public bool CanDelete { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyCanFileBeDeleted As OnNotifyCanFileBeDeletedHandler

Public Delegate Sub OnNotifyCanFileBeDeletedHandler(sender As Object, e As CBMonitorNotifyCanFileBeDeletedEventArgs)

Public Class CBMonitorNotifyCanFileBeDeletedEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property RequestType As Integer
  Public ReadOnly Property CanDelete As Boolean
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyCleanupFileHandler OnNotifyCleanupFile;

public delegate void OnNotifyCleanupFileHandler(object sender, CBMonitorNotifyCleanupFileEventArgs e);

public class CBMonitorNotifyCleanupFileEventArgs : EventArgs {
  public string FileName { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyCleanupFile As OnNotifyCleanupFileHandler

Public Delegate Sub OnNotifyCleanupFileHandler(sender As Object, e As CBMonitorNotifyCleanupFileEventArgs)

Public Class CBMonitorNotifyCleanupFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyCloseFileHandler OnNotifyCloseFile;

public delegate void OnNotifyCloseFileHandler(object sender, CBMonitorNotifyCloseFileEventArgs e);

public class CBMonitorNotifyCloseFileEventArgs : EventArgs {
  public string FileName { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyCloseFile As OnNotifyCloseFileHandler

Public Delegate Sub OnNotifyCloseFileHandler(sender As Object, e As CBMonitorNotifyCloseFileEventArgs)

Public Class CBMonitorNotifyCloseFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyCreateFileHandler OnNotifyCreateFile;

public delegate void OnNotifyCreateFileHandler(object sender, CBMonitorNotifyCreateFileEventArgs e);

public class CBMonitorNotifyCreateFileEventArgs : EventArgs {
  public string FileName { get; }
  public int ExistingAttributes { get; }
  public int DesiredAccess { get; }
  public int Attributes { get; }
  public int ShareMode { get; }
  public int Options { get; }
  public int CreateDisposition { get; }
  public IntPtr SecurityDescriptor { get; }
  public int Length { get; }
  public int Status { get; }
  public int CreationStatus { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyCreateFile As OnNotifyCreateFileHandler

Public Delegate Sub OnNotifyCreateFileHandler(sender As Object, e As CBMonitorNotifyCreateFileEventArgs)

Public Class CBMonitorNotifyCreateFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property ExistingAttributes As Integer
  Public ReadOnly Property DesiredAccess As Integer
  Public ReadOnly Property Attributes As Integer
  Public ReadOnly Property ShareMode As Integer
  Public ReadOnly Property Options As Integer
  Public ReadOnly Property CreateDisposition As Integer
  Public ReadOnly Property SecurityDescriptor As IntPtr
  Public ReadOnly Property Length As Integer
  Public ReadOnly Property Status As Integer
  Public ReadOnly Property CreationStatus As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyCreateHardLinkHandler OnNotifyCreateHardLink;

public delegate void OnNotifyCreateHardLinkHandler(object sender, CBMonitorNotifyCreateHardLinkEventArgs e);

public class CBMonitorNotifyCreateHardLinkEventArgs : EventArgs {
  public string FileName { get; }
  public string LinkName { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyCreateHardLink As OnNotifyCreateHardLinkHandler

Public Delegate Sub OnNotifyCreateHardLinkHandler(sender As Object, e As CBMonitorNotifyCreateHardLinkEventArgs)

Public Class CBMonitorNotifyCreateHardLinkEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property LinkName As String
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyDeleteFileHandler OnNotifyDeleteFile;

public delegate void OnNotifyDeleteFileHandler(object sender, CBMonitorNotifyDeleteFileEventArgs e);

public class CBMonitorNotifyDeleteFileEventArgs : EventArgs {
  public string FileName { get; }
  public int RequestType { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyDeleteFile As OnNotifyDeleteFileHandler

Public Delegate Sub OnNotifyDeleteFileHandler(sender As Object, e As CBMonitorNotifyDeleteFileEventArgs)

Public Class CBMonitorNotifyDeleteFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property RequestType As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyDeleteReparsePointHandler OnNotifyDeleteReparsePoint;

public delegate void OnNotifyDeleteReparsePointHandler(object sender, CBMonitorNotifyDeleteReparsePointEventArgs e);

public class CBMonitorNotifyDeleteReparsePointEventArgs : EventArgs {
  public string FileName { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyDeleteReparsePoint As OnNotifyDeleteReparsePointHandler

Public Delegate Sub OnNotifyDeleteReparsePointHandler(sender As Object, e As CBMonitorNotifyDeleteReparsePointEventArgs)

Public Class CBMonitorNotifyDeleteReparsePointEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyEnumerateDirectoryHandler OnNotifyEnumerateDirectory;

public delegate void OnNotifyEnumerateDirectoryHandler(object sender, CBMonitorNotifyEnumerateDirectoryEventArgs e);

public class CBMonitorNotifyEnumerateDirectoryEventArgs : EventArgs {
  public string DirectoryName { get; }
  public int Flags { get; }
  public int Index { get; }
  public string FileName { get; }
  public DateTime CreationTime { get; }
  public DateTime LastAccessTime { get; }
  public DateTime LastWriteTime { get; }
  public DateTime ChangeTime { get; }
  public long Size { get; }
  public long AllocationSize { get; }
  public long FileId { get; }
  public int Attributes { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyEnumerateDirectory As OnNotifyEnumerateDirectoryHandler

Public Delegate Sub OnNotifyEnumerateDirectoryHandler(sender As Object, e As CBMonitorNotifyEnumerateDirectoryEventArgs)

Public Class CBMonitorNotifyEnumerateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property DirectoryName As String
  Public ReadOnly Property Flags As Integer
  Public ReadOnly Property Index As Integer
  Public ReadOnly Property FileName As String
  Public ReadOnly Property CreationTime As DateTime
  Public ReadOnly Property LastAccessTime As DateTime
  Public ReadOnly Property LastWriteTime As DateTime
  Public ReadOnly Property ChangeTime As DateTime
  Public ReadOnly Property Size As Long
  Public ReadOnly Property AllocationSize As Long
  Public ReadOnly Property FileId As Long
  Public ReadOnly Property Attributes As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyFilterAttachToVolumeHandler OnNotifyFilterAttachToVolume;

public delegate void OnNotifyFilterAttachToVolumeHandler(object sender, CBMonitorNotifyFilterAttachToVolumeEventArgs e);

public class CBMonitorNotifyFilterAttachToVolumeEventArgs : EventArgs {
  public string VolumeName { get; }
  public string VolumeNameNT { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyFilterAttachToVolume As OnNotifyFilterAttachToVolumeHandler

Public Delegate Sub OnNotifyFilterAttachToVolumeHandler(sender As Object, e As CBMonitorNotifyFilterAttachToVolumeEventArgs)

Public Class CBMonitorNotifyFilterAttachToVolumeEventArgs Inherits EventArgs
  Public ReadOnly Property VolumeName As String
  Public ReadOnly Property VolumeNameNT As String
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyFilterDetachFromVolumeHandler OnNotifyFilterDetachFromVolume;

public delegate void OnNotifyFilterDetachFromVolumeHandler(object sender, CBMonitorNotifyFilterDetachFromVolumeEventArgs e);

public class CBMonitorNotifyFilterDetachFromVolumeEventArgs : EventArgs {
  public string VolumeName { get; }
  public string VolumeNameNT { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyFilterDetachFromVolume As OnNotifyFilterDetachFromVolumeHandler

Public Delegate Sub OnNotifyFilterDetachFromVolumeHandler(sender As Object, e As CBMonitorNotifyFilterDetachFromVolumeEventArgs)

Public Class CBMonitorNotifyFilterDetachFromVolumeEventArgs Inherits EventArgs
  Public ReadOnly Property VolumeName As String
  Public ReadOnly Property VolumeNameNT As String
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyFsctlHandler OnNotifyFsctl;

public delegate void OnNotifyFsctlHandler(object sender, CBMonitorNotifyFsctlEventArgs e);

public class CBMonitorNotifyFsctlEventArgs : EventArgs {
  public string FileName { get; }
  public int FsControlCode { get; }
  public IntPtr InBuffer { get; }
  public int InBufferLength { get; }
  public int InBufferValidBytes { get; }
  public IntPtr OutBuffer { get; }
  public int OutBufferLength { get; }
  public int OutBufferValidBytes { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyFsctl As OnNotifyFsctlHandler

Public Delegate Sub OnNotifyFsctlHandler(sender As Object, e As CBMonitorNotifyFsctlEventArgs)

Public Class CBMonitorNotifyFsctlEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property FsControlCode As Integer
  Public ReadOnly Property InBuffer As IntPtr
  Public ReadOnly Property InBufferLength As Integer
  Public ReadOnly Property InBufferValidBytes As Integer
  Public ReadOnly Property OutBuffer As IntPtr
  Public ReadOnly Property OutBufferLength As Integer
  Public ReadOnly Property OutBufferValidBytes As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyGetFileSecurityHandler OnNotifyGetFileSecurity;

public delegate void OnNotifyGetFileSecurityHandler(object sender, CBMonitorNotifyGetFileSecurityEventArgs e);

public class CBMonitorNotifyGetFileSecurityEventArgs : EventArgs {
  public string FileName { get; }
  public int SecurityInformation { get; }
  public IntPtr SecurityDescriptor { get; }
  public int Length { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyGetFileSecurity As OnNotifyGetFileSecurityHandler

Public Delegate Sub OnNotifyGetFileSecurityHandler(sender As Object, e As CBMonitorNotifyGetFileSecurityEventArgs)

Public Class CBMonitorNotifyGetFileSecurityEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property SecurityInformation As Integer
  Public ReadOnly Property SecurityDescriptor As IntPtr
  Public ReadOnly Property Length As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyGetFileSizesHandler OnNotifyGetFileSizes;

public delegate void OnNotifyGetFileSizesHandler(object sender, CBMonitorNotifyGetFileSizesEventArgs e);

public class CBMonitorNotifyGetFileSizesEventArgs : EventArgs {
  public string FileName { get; }
  public long Size { get; }
  public long AllocationSize { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyGetFileSizes As OnNotifyGetFileSizesHandler

Public Delegate Sub OnNotifyGetFileSizesHandler(sender As Object, e As CBMonitorNotifyGetFileSizesEventArgs)

Public Class CBMonitorNotifyGetFileSizesEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Size As Long
  Public ReadOnly Property AllocationSize As Long
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyGetReparsePointHandler OnNotifyGetReparsePoint;

public delegate void OnNotifyGetReparsePointHandler(object sender, CBMonitorNotifyGetReparsePointEventArgs e);

public class CBMonitorNotifyGetReparsePointEventArgs : EventArgs {
  public string FileName { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyGetReparsePoint As OnNotifyGetReparsePointHandler

Public Delegate Sub OnNotifyGetReparsePointHandler(sender As Object, e As CBMonitorNotifyGetReparsePointEventArgs)

Public Class CBMonitorNotifyGetReparsePointEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyIoctlHandler OnNotifyIoctl;

public delegate void OnNotifyIoctlHandler(object sender, CBMonitorNotifyIoctlEventArgs e);

public class CBMonitorNotifyIoctlEventArgs : EventArgs {
  public string FileName { get; }
  public int IoControlCode { get; }
  public IntPtr InBuffer { get; }
  public int InBufferLength { get; }
  public int InBufferValidBytes { get; }
  public IntPtr OutBuffer { get; }
  public int OutBufferLength { get; }
  public int OutBufferValidBytes { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyIoctl As OnNotifyIoctlHandler

Public Delegate Sub OnNotifyIoctlHandler(sender As Object, e As CBMonitorNotifyIoctlEventArgs)

Public Class CBMonitorNotifyIoctlEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property IoControlCode As Integer
  Public ReadOnly Property InBuffer As IntPtr
  Public ReadOnly Property InBufferLength As Integer
  Public ReadOnly Property InBufferValidBytes As Integer
  Public ReadOnly Property OutBuffer As IntPtr
  Public ReadOnly Property OutBufferLength As Integer
  Public ReadOnly Property OutBufferValidBytes As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyLockHandler OnNotifyLock;

public delegate void OnNotifyLockHandler(object sender, CBMonitorNotifyLockEventArgs e);

public class CBMonitorNotifyLockEventArgs : EventArgs {
  public string FileName { get; }
  public long Offset { get; }
  public long Length { get; }
  public long Key { get; }
  public bool FailImmediately { get; }
  public bool ExclusiveLock { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyLock As OnNotifyLockHandler

Public Delegate Sub OnNotifyLockHandler(sender As Object, e As CBMonitorNotifyLockEventArgs)

Public Class CBMonitorNotifyLockEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Offset As Long
  Public ReadOnly Property Length As Long
  Public ReadOnly Property Key As Long
  Public ReadOnly Property FailImmediately As Boolean
  Public ReadOnly Property ExclusiveLock As Boolean
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyOpenFileHandler OnNotifyOpenFile;

public delegate void OnNotifyOpenFileHandler(object sender, CBMonitorNotifyOpenFileEventArgs e);

public class CBMonitorNotifyOpenFileEventArgs : EventArgs {
  public string FileName { get; }
  public int ExistingAttributes { get; }
  public int DesiredAccess { get; }
  public int Attributes { get; }
  public int ShareMode { get; }
  public int Options { get; }
  public int CreateDisposition { get; }
  public IntPtr SecurityDescriptor { get; }
  public int Length { get; }
  public int Status { get; }
  public int CreationStatus { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyOpenFile As OnNotifyOpenFileHandler

Public Delegate Sub OnNotifyOpenFileHandler(sender As Object, e As CBMonitorNotifyOpenFileEventArgs)

Public Class CBMonitorNotifyOpenFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property ExistingAttributes As Integer
  Public ReadOnly Property DesiredAccess As Integer
  Public ReadOnly Property Attributes As Integer
  Public ReadOnly Property ShareMode As Integer
  Public ReadOnly Property Options As Integer
  Public ReadOnly Property CreateDisposition As Integer
  Public ReadOnly Property SecurityDescriptor As IntPtr
  Public ReadOnly Property Length As Integer
  Public ReadOnly Property Status As Integer
  Public ReadOnly Property CreationStatus As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyQueryEaHandler OnNotifyQueryEa;

public delegate void OnNotifyQueryEaHandler(object sender, CBMonitorNotifyQueryEaEventArgs e);

public class CBMonitorNotifyQueryEaEventArgs : EventArgs {
  public string FileName { get; }
  public IntPtr Buffer { get; }
  public int BufferLength { get; }
  public bool ReturnSingleEntry { get; }
  public IntPtr EaList { get; }
  public int EaListLength { get; }
  public int EaIndex { get; }
  public bool RestartScan { get; }
  public int LengthReturned { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyQueryEa As OnNotifyQueryEaHandler

Public Delegate Sub OnNotifyQueryEaHandler(sender As Object, e As CBMonitorNotifyQueryEaEventArgs)

Public Class CBMonitorNotifyQueryEaEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Buffer As IntPtr
  Public ReadOnly Property BufferLength As Integer
  Public ReadOnly Property ReturnSingleEntry As Boolean
  Public ReadOnly Property EaList As IntPtr
  Public ReadOnly Property EaListLength As Integer
  Public ReadOnly Property EaIndex As Integer
  Public ReadOnly Property RestartScan As Boolean
  Public ReadOnly Property LengthReturned As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyQueryFileInfoHandler OnNotifyQueryFileInfo;

public delegate void OnNotifyQueryFileInfoHandler(object sender, CBMonitorNotifyQueryFileInfoEventArgs e);

public class CBMonitorNotifyQueryFileInfoEventArgs : EventArgs {
  public string FileName { get; }
  public int FileInformationClass { get; }
  public IntPtr Buffer { get; }
  public int BufferLength { get; }
  public int ValidBytes { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyQueryFileInfo As OnNotifyQueryFileInfoHandler

Public Delegate Sub OnNotifyQueryFileInfoHandler(sender As Object, e As CBMonitorNotifyQueryFileInfoEventArgs)

Public Class CBMonitorNotifyQueryFileInfoEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property FileInformationClass As Integer
  Public ReadOnly Property Buffer As IntPtr
  Public ReadOnly Property BufferLength As Integer
  Public ReadOnly Property ValidBytes As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyReadFileHandler OnNotifyReadFile;

public delegate void OnNotifyReadFileHandler(object sender, CBMonitorNotifyReadFileEventArgs e);

public class CBMonitorNotifyReadFileEventArgs : EventArgs {
  public string FileName { get; }
  public long Position { get; }
  public int BytesToRead { get; }
  public int Direction { get; }
  public int BytesRead { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyReadFile As OnNotifyReadFileHandler

Public Delegate Sub OnNotifyReadFileHandler(sender As Object, e As CBMonitorNotifyReadFileEventArgs)

Public Class CBMonitorNotifyReadFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property Position As Long
  Public ReadOnly Property BytesToRead As Integer
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property BytesRead As Integer
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifyRenameOrMoveFileHandler OnNotifyRenameOrMoveFile;

public delegate void OnNotifyRenameOrMoveFileHandler(object sender, CBMonitorNotifyRenameOrMoveFileEventArgs e);

public class CBMonitorNotifyRenameOrMoveFileEventArgs : EventArgs {
  public string FileName { get; }
  public string NewFileName { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifyRenameOrMoveFile As OnNotifyRenameOrMoveFileHandler

Public Delegate Sub OnNotifyRenameOrMoveFileHandler(sender As Object, e As CBMonitorNotifyRenameOrMoveFileEventArgs)

Public Class CBMonitorNotifyRenameOrMoveFileEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property NewFileName As String
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class

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

• C#
• VB.NET

public event OnNotifySetAllocationSizeHandler OnNotifySetAllocationSize;

public delegate void OnNotifySetAllocationSizeHandler(object sender, CBMonitorNotifySetAllocationSizeEventArgs e);

public class CBMonitorNotifySetAllocationSizeEventArgs : EventArgs {
  public string FileName { get; }
  public long AllocationSize { get; }
  public int Status { get; }
  public int ResultCode { get; set; }
}

Public Event OnNotifySetAllocationSize As OnNotifySetAllocationSizeHandler

Public Delegate Sub OnNotifySetAllocationSizeHandler(sender As Object, e As CBMonitorNotifySetAllocationSizeEventArgs)

Public Class CBMonitorNotifySetAllocationSizeEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property AllocationSize As Long
  Public ReadOnly Property Status As Integer
  Public Property ResultCode As Integer
End Class