BeforeSetFileSecurity Event

Fires before a file or directory's security attributes are changed.

Syntax

// CBFilterBeforeSetFileSecurityEventArgs carries the CBFilter BeforeSetFileSecurity event's parameters.
type CBFilterBeforeSetFileSecurityEventArgs struct {...}

func (args *CBFilterBeforeSetFileSecurityEventArgs) FileName() string
func (args *CBFilterBeforeSetFileSecurityEventArgs) SecurityInformation() int32
func (args *CBFilterBeforeSetFileSecurityEventArgs) SecurityDescriptor() []byte
func (args *CBFilterBeforeSetFileSecurityEventArgs) SetSecurityDescriptor(value []byte)
func (args *CBFilterBeforeSetFileSecurityEventArgs) Length() int32
func (args *CBFilterBeforeSetFileSecurityEventArgs) FileContext() int64
func (args *CBFilterBeforeSetFileSecurityEventArgs) SetFileContext(value int64)
func (args *CBFilterBeforeSetFileSecurityEventArgs) HandleContext() int64
func (args *CBFilterBeforeSetFileSecurityEventArgs) SetHandleContext(value int64)
func (args *CBFilterBeforeSetFileSecurityEventArgs) ProcessRequest() bool
func (args *CBFilterBeforeSetFileSecurityEventArgs) SetProcessRequest(value bool)
func (args *CBFilterBeforeSetFileSecurityEventArgs) ResultCode() int32
func (args *CBFilterBeforeSetFileSecurityEventArgs) SetResultCode(value int32)

// CBFilterBeforeSetFileSecurityEvent defines the signature of the CBFilter BeforeSetFileSecurity event's handler function.
type CBFilterBeforeSetFileSecurityEvent func(sender *CBFilter, args *CBFilterBeforeSetFileSecurityEventArgs)

func (obj *CBFilter) GetOnBeforeSetFileSecurityHandler() CBFilterBeforeSetFileSecurityEvent
func (obj *CBFilter) SetOnBeforeSetFileSecurityHandler(handlerFunc CBFilterBeforeSetFileSecurityEvent)

Remarks

This event fires before security attributes are changed for the file or directory specified by FileName.

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

The SecurityInformation parameter reflects which pieces of security information, of those present in SecurityDescriptor, will be set. Please refer to Microsoft's SECURITY_INFORMATION data type documentation for more information about possible values.

The SecurityDescriptor parameter points to a memory buffer that specifies the new security information. The buffer referenced by the SecurityDescriptor parameter may be modified when needed if the request is to be passed further to other filters and the filesystem driver. The Length parameter reflects the length of this data, in bytes. Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

The data itself is formatted as a SECURITY_DESCRIPTOR structure in self-relative format; please refer to the Microsoft's documentation for more information.

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.