AfterRenameOrMoveFile Event

Fires after a file or directory is renamed or moved.

Syntax

// CBFilterAfterRenameOrMoveFileEventArgs carries the CBFilter AfterRenameOrMoveFile event's parameters.
type CBFilterAfterRenameOrMoveFileEventArgs struct {...}

func (args *CBFilterAfterRenameOrMoveFileEventArgs) FileName() string
func (args *CBFilterAfterRenameOrMoveFileEventArgs) NewFileName() string
func (args *CBFilterAfterRenameOrMoveFileEventArgs) Status() int32
func (args *CBFilterAfterRenameOrMoveFileEventArgs) SetStatus(value int32)
func (args *CBFilterAfterRenameOrMoveFileEventArgs) FileContext() int64
func (args *CBFilterAfterRenameOrMoveFileEventArgs) SetFileContext(value int64)
func (args *CBFilterAfterRenameOrMoveFileEventArgs) HandleContext() int64
func (args *CBFilterAfterRenameOrMoveFileEventArgs) SetHandleContext(value int64)
func (args *CBFilterAfterRenameOrMoveFileEventArgs) ResultCode() int32
func (args *CBFilterAfterRenameOrMoveFileEventArgs) SetResultCode(value int32)

// CBFilterAfterRenameOrMoveFileEvent defines the signature of the CBFilter AfterRenameOrMoveFile event's handler function.
type CBFilterAfterRenameOrMoveFileEvent func(sender *CBFilter, args *CBFilterAfterRenameOrMoveFileEventArgs)

func (obj *CBFilter) GetOnAfterRenameOrMoveFileHandler() CBFilterAfterRenameOrMoveFileEvent
func (obj *CBFilter) SetOnAfterRenameOrMoveFileHandler(handlerFunc CBFilterAfterRenameOrMoveFileEvent)

Remarks

This event fires after the file or directory specified by FileName is renamed or moved to NewFileName.

Applications only need to handle this event if they've added a standard filter rule that includes the FS_CE_AFTER_RENAME flag. A rule's mask is matched against both previous and new filenames and the event will fire when either of the names matches the mask.

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 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.