BeforeUnlockAll Event

Fires before all locked byte ranges in a file are unlocked.

Syntax

class CBFilterBeforeUnlockAllEventParams {
public:
  const QString &FileName();
  void *FileContext();
  void SetFileContext(void *lpFileContext);
  void *HandleContext();
  void SetHandleContext(void *lpHandleContext);
  bool ProcessRequest();
  void SetProcessRequest(bool bProcessRequest);
  int ResultCode();
  void SetResultCode(int iResultCode);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BeforeUnlockAll(CBFilterBeforeUnlockAllEventParams *e);

// Or, subclass CBFilter and override this emitter function.
virtual int FireBeforeUnlockAll(CBFilterBeforeUnlockAllEventParams *e) {...}

Remarks

This event fires before all locked byte ranges in the file specified by FileName are unlocked.

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

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.

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.