NotifyGetFileSizes Event

Fires when a file's size information has been retrieved.

Syntax

// CBFilterNotifyGetFileSizesEventArgs carries the CBFilter NotifyGetFileSizes event's parameters.
type CBFilterNotifyGetFileSizesEventArgs struct {...}

func (args *CBFilterNotifyGetFileSizesEventArgs) FileName() string
func (args *CBFilterNotifyGetFileSizesEventArgs) Size() int64
func (args *CBFilterNotifyGetFileSizesEventArgs) AllocationSize() int64
func (args *CBFilterNotifyGetFileSizesEventArgs) Status() int32
func (args *CBFilterNotifyGetFileSizesEventArgs) ResultCode() int32
func (args *CBFilterNotifyGetFileSizesEventArgs) SetResultCode(value int32)

// CBFilterNotifyGetFileSizesEvent defines the signature of the CBFilter NotifyGetFileSizes event's handler function.
type CBFilterNotifyGetFileSizesEvent func(sender *CBFilter, args *CBFilterNotifyGetFileSizesEventArgs)

func (obj *CBFilter) GetOnNotifyGetFileSizesHandler() CBFilterNotifyGetFileSizesEvent
func (obj *CBFilter) SetOnNotifyGetFileSizesHandler(handlerFunc CBFilterNotifyGetFileSizesEvent)

Remarks

This event fires when size information has been retrieved for the file specified by FileName.

Applications only need to handle this event if they've 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. 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.