CloseDirectoryEnumeration Event

Fires when the OS is finished enumerating a directory's contents.

Syntax

// CBFSCloseDirectoryEnumerationEventArgs carries the CBFS CloseDirectoryEnumeration event's parameters.
type CBFSCloseDirectoryEnumerationEventArgs struct {...}

func (args *CBFSCloseDirectoryEnumerationEventArgs) DirectoryName() string
func (args *CBFSCloseDirectoryEnumerationEventArgs) DirectoryContext() int64
func (args *CBFSCloseDirectoryEnumerationEventArgs) SetDirectoryContext(value int64)
func (args *CBFSCloseDirectoryEnumerationEventArgs) EnumerationContext() int64
func (args *CBFSCloseDirectoryEnumerationEventArgs) ResultCode() int32
func (args *CBFSCloseDirectoryEnumerationEventArgs) SetResultCode(value int32)

// CBFSCloseDirectoryEnumerationEvent defines the signature of the CBFS CloseDirectoryEnumeration event's handler function.
type CBFSCloseDirectoryEnumerationEvent func(sender *CBFS, args *CBFSCloseDirectoryEnumerationEventArgs)

func (obj *CBFS) GetOnCloseDirectoryEnumerationHandler() CBFSCloseDirectoryEnumerationEvent
func (obj *CBFS) SetOnCloseDirectoryEnumerationHandler(handlerFunc CBFSCloseDirectoryEnumerationEvent)

Remarks

This event fires when the OS is finished enumerating the contents of the directory specified by DirectoryName.

To handle this event properly, applications must release any resources that were allocated for/by the directory enumeration in earlier EnumerateDirectory events.

The DirectoryContext and EnumerationContext parameters are placeholders for application-defined data associated with the directory and enumeration, respectively. Please refer to the Contexts topic for more information about them.

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.