CBFS Connect 2020 Node.js Edition

Questions / Feedback?

CloseDirectoryEnumeration Event

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

Syntax

cbfs.on('CloseDirectoryEnumeration', [callback])

Callback

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

function(e){ }

The argument 'e' has the following properties:

e.directoryName
e.directoryContext
e.enumerationContext
e.resultCode

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.

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