AfterUnlockSingle Event

Fires after a particular locked byte range in a file is unlocked.

Syntax

// CBFilterAfterUnlockSingleEventArgs carries the CBFilter AfterUnlockSingle event's parameters.
type CBFilterAfterUnlockSingleEventArgs struct {...}

func (args *CBFilterAfterUnlockSingleEventArgs) FileName() string
func (args *CBFilterAfterUnlockSingleEventArgs) Offset() int64
func (args *CBFilterAfterUnlockSingleEventArgs) Length() int64
func (args *CBFilterAfterUnlockSingleEventArgs) Key() int64
func (args *CBFilterAfterUnlockSingleEventArgs) Status() int32
func (args *CBFilterAfterUnlockSingleEventArgs) SetStatus(value int32)
func (args *CBFilterAfterUnlockSingleEventArgs) FileContext() int64
func (args *CBFilterAfterUnlockSingleEventArgs) SetFileContext(value int64)
func (args *CBFilterAfterUnlockSingleEventArgs) HandleContext() int64
func (args *CBFilterAfterUnlockSingleEventArgs) SetHandleContext(value int64)
func (args *CBFilterAfterUnlockSingleEventArgs) ResultCode() int32
func (args *CBFilterAfterUnlockSingleEventArgs) SetResultCode(value int32)

// CBFilterAfterUnlockSingleEvent defines the signature of the CBFilter AfterUnlockSingle event's handler function.
type CBFilterAfterUnlockSingleEvent func(sender *CBFilter, args *CBFilterAfterUnlockSingleEventArgs)

func (obj *CBFilter) GetOnAfterUnlockSingleHandler() CBFilterAfterUnlockSingleEvent
func (obj *CBFilter) SetOnAfterUnlockSingleHandler(handlerFunc CBFilterAfterUnlockSingleEvent)

Remarks

This event fires after a particular locked byte range in the file specified by FileName is 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 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 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.