BeforeCleanupFile Event

Fires before a file or directory handle is closed.

Syntax

public class DefaultCbfilterEventListener implements CbfilterEventListener {
  ...
  public void beforeCleanupFile(CbfilterBeforeCleanupFileEvent e) {}
  ...
}

public class CbfilterBeforeCleanupFileEvent {
  public String fileName;
  public long fileContext;
  public long handleContext;
  public int resultCode;
}

Remarks

This event fires before a handle to the file or directory specified by FileName is closed. This event differs from BeforeCloseFile in that BeforeCleanupFile fires immediately before an open handle to the specified file or directory is closed by a process, whereas BeforeCloseFile 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 BeforeCloseFile event fires. For example, system components such as the memory manager or cache manager may cause the BeforeReadFile and BeforeWriteFile events to fire.

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

The FileContext and HandleContext parameters are placeholders for application-defined data associated with the file and specific handle, 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.

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