BeforeCloseFile Event

Fires before a file or directory is closed.

Syntax

// CBFilterBeforeCloseFileEventArgs carries the CBFilter BeforeCloseFile event's parameters.
type CBFilterBeforeCloseFileEventArgs struct {...}

func (args *CBFilterBeforeCloseFileEventArgs) FileName() string
func (args *CBFilterBeforeCloseFileEventArgs) FileContext() int64
func (args *CBFilterBeforeCloseFileEventArgs) SetFileContext(value int64)
func (args *CBFilterBeforeCloseFileEventArgs) HandleContext() int64
func (args *CBFilterBeforeCloseFileEventArgs) SetHandleContext(value int64)
func (args *CBFilterBeforeCloseFileEventArgs) ResultCode() int32
func (args *CBFilterBeforeCloseFileEventArgs) SetResultCode(value int32)

// CBFilterBeforeCloseFileEvent defines the signature of the CBFilter BeforeCloseFile event's handler function.
type CBFilterBeforeCloseFileEvent func(sender *CBFilter, args *CBFilterBeforeCloseFileEventArgs)

func (obj *CBFilter) GetOnBeforeCloseFileHandler() CBFilterBeforeCloseFileEvent
func (obj *CBFilter) SetOnBeforeCloseFileHandler(handlerFunc CBFilterBeforeCloseFileEvent)

Remarks

This event fires before the file or directory specified by FileName is closed.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_BEFORE_CLOSE 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 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.