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

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

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. Please note that this event won't 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, however, that this event fires after the operation has already completed, so reporting an error won't actually affect the operation itself. Please refer to the Error Reporting and Handling topic for more information.

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