DeleteVirtualFile Event

Fires when a virtual file needs to be deleted.

Syntax

// CBFilterDeleteVirtualFileEventArgs carries the CBFilter DeleteVirtualFile event's parameters.
type CBFilterDeleteVirtualFileEventArgs struct {...}

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

// CBFilterDeleteVirtualFileEvent defines the signature of the CBFilter DeleteVirtualFile event's handler function.
type CBFilterDeleteVirtualFileEvent func(sender *CBFilter, args *CBFilterDeleteVirtualFileEventArgs)

func (obj *CBFilter) GetOnDeleteVirtualFileHandler() CBFilterDeleteVirtualFileEvent
func (obj *CBFilter) SetOnDeleteVirtualFileHandler(handlerFunc CBFilterDeleteVirtualFileEvent)

Remarks

This event fires when the virtual file or directory specified by FileName needs to be deleted, allowing the application to perform the necessary cleanup.

Applications only need to handle this event if they intend to use virtual files; please refer to the Virtual Files topic for more information. This event is not fired when a regular file or directory is deleted.

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.