CBFS Filter 2020 Node.js Edition

Questions / Feedback?

BeforeSetFileSize Event

Fires before a file is resized.

Syntax

cbfilter.on('BeforeSetFileSize', [callback])

Callback

The 'callback' is called when the 'BeforeSetFileSize' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.fileName
e.size
e.fileContext
e.handleContext
e.processRequest
e.resultCode

Remarks

This event fires before the file specified by FileName is resized, whether explicitly (e.g., truncation) or implicitly (i.e., as data is appended).

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 Size parameter specifies the new file size, in bytes.

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 0.)

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 Node.js Edition - Version 20.0 [Build 8164]