CBFS Filter 2020 Node.js Edition

Questions / Feedback?

AfterUnlockAllByKey Event

Fires after all locked byte ranges in a file, associated with a particular key, are unlocked.

Syntax

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

Callback

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

function(e){ }

The argument 'e' has the following properties:

e.fileName
e.key
e.status
e.fileContext
e.handleContext
e.resultCode

Remarks

This event fires after all locked byte ranges in the file specified by FileName, and associated with the specified Key, are unlocked.

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

The Key parameter contains the key value specified when the byte ranges were locked. Please refer to the AfterLock event's documentation for more information.

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. Applications may change this parameter's value if they want a different NT status code to be returned.

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) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Node.js Edition - Version 20.0 [Build 7917]