CBFS Filter 2020 Node.js Edition

Questions / Feedback?

AfterSetFileSecurity Event

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

Syntax

cbfilter.on('AfterSetFileSecurity', [callback])

Callback

The 'callback' is called when the 'AfterSetFileSecurity' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.fileName
e.securityInformation
e.securityDescriptor
e.length
e.status
e.fileContext
e.handleContext
e.resultCode

Remarks

This event fires after 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_AFTER_SET_SECURITY flag.

The SecurityInformation parameter reflects which pieces of security information, of those present in SecurityDescriptor, were to 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 contains the new security information. 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 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.

Copyright (c) 2022 Callback Technologies, Inc. - All rights reserved.
CBFS Filter 2020 Node.js Edition - Version 20.0 [Build 8164]