BeforeSetAllocationSize Event

Fires before a file's allocation size is changed.

Syntax

public event OnBeforeSetAllocationSizeHandler OnBeforeSetAllocationSize;

public delegate void OnBeforeSetAllocationSizeHandler(object sender, CbfilterBeforeSetAllocationSizeEventArgs e);

public class CbfilterBeforeSetAllocationSizeEventArgs : EventArgs {
  public string FileName { get; }
  public long AllocationSize { get; set; }
  public IntPtr FileContext { get; set; }
  public IntPtr HandleContext { get; set; }
  public bool ProcessRequest { get; set; }
  public int ResultCode { get; set; }
}
Public Event OnBeforeSetAllocationSize As OnBeforeSetAllocationSizeHandler

Public Delegate Sub OnBeforeSetAllocationSizeHandler(sender As Object, e As CbfilterBeforeSetAllocationSizeEventArgs)

Public Class CbfilterBeforeSetAllocationSizeEventArgs Inherits EventArgs
  Public ReadOnly Property FileName As String
  Public Property AllocationSize As Long
  Public Property FileContext As IntPtr
  Public Property HandleContext As IntPtr
  Public Property ProcessRequest As Boolean
  Public Property ResultCode As Integer
End Class

Remarks

This event fires before the allocation size of the file specified by FileName is changed.

Applications may use this event to modify the request's parameters.

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

The AllocationSize parameter specifies the new allocation size, in bytes. A file's allocation size is typically larger than its actual size since filesystem operations often reserve space on disk before writing additional data to a file. Applications may track such situations and avoid reallocating disk space where possible to improve performance.

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. (If the system's cache manager or memory manager initiated the operation, HandleContext may be absent, in which case it will be IntPtr.Zero.)

The ProcessRequest parameter controls whether the request is sent onwards for further processing by subsequent filter drivers and the filesystem; it is true by default.

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.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 .NET Edition - Version 20.0 [Build 8317]