NotifyUnlockSingle Event

Fires when a particular locked byte range in a file has been unlocked.

Syntax

ANSI (Cross Platform)
virtual int FireNotifyUnlockSingle(CBFilterNotifyUnlockSingleEventParams *e);
typedef struct {
const char *FileName;
int64 Offset;
int64 Length;
int64 Key;
int Status;
int ResultCode; int reserved; } CBFilterNotifyUnlockSingleEventParams; Unicode (Windows) virtual INT FireNotifyUnlockSingle(CBFilterNotifyUnlockSingleEventParams *e);
typedef struct {
LPCWSTR FileName;
LONG64 Offset;
LONG64 Length;
LONG64 Key;
INT Status;
INT ResultCode; INT reserved; } CBFilterNotifyUnlockSingleEventParams;
#define EID_CBFILTER_NOTIFYUNLOCKSINGLE 83

virtual INT CBFSFILTER_CALL FireNotifyUnlockSingle(LPWSTR &lpszFileName, LONG64 &lOffset, LONG64 &lLength, LONG64 &lKey, INT &iStatus, INT &iResultCode);

Remarks

This event fires when a particular locked byte range in the file specified by FileName has been unlocked.

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

The Offset, Length, and Key parameters contain the starting byte offset, length, and key values (respectively) specified when the byte range was locked. Please refer to the NotifyLock 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.

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.

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