CloseHardLinksEnumeration Event

Fires when the OS is finished enumerating a file's hard links.

Syntax

• C#
• VB.NET

public event OnCloseHardLinksEnumerationHandler OnCloseHardLinksEnumeration;

public delegate void OnCloseHardLinksEnumerationHandler(object sender, CbfsCloseHardLinksEnumerationEventArgs e);

public class CbfsCloseHardLinksEnumerationEventArgs : EventArgs {
  public string FileName { get; }
  public long HandleInfo { get; }
  public IntPtr FileContext { get; set; }
  public IntPtr HandleContext { get; set; }
  public IntPtr EnumerationContext { get; }
  public int ResultCode { get; set; }
}

Public Event OnCloseHardLinksEnumeration As OnCloseHardLinksEnumerationHandler

Public Delegate Sub OnCloseHardLinksEnumerationHandler(sender As Object, e As CbfsCloseHardLinksEnumerationEventArgs)

Public Class CbfsCloseHardLinksEnumerationEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public ReadOnly Property HandleInfo As Long
  Public Property FileContext As IntPtr
  Public Property HandleContext As IntPtr
  Public ReadOnly Property EnumerationContext As IntPtr
  Public Property ResultCode As Integer
End Class

Remarks

This event fires when the OS is finished enumerating the hard links of the file specified by FileName.

This event only needs to be handled if the UseHardLinks property is enabled. To handle this event properly, applications must release any resources that were allocated for/by the hard link enumeration in earlier EnumerateHardLinks events.

The HandleInfo parameter carries a handle to an object with information about the file handle. While within the event handler, it can be used to call any of the following methods: GetHandleCreatorProcessId, GetHandleCreatorProcessName, GetHandleCreatorThreadId, or GetHandleCreatorToken.

The FileContext, HandleContext, and EnumerationContext parameters are placeholders for application-defined data associated with the file, specific handle, and enumeration; respectively. Please refer to the Contexts topic for more information.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a non-zero value to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.