CBFS Storage 2020 Node.js Edition

Questions / Feedback?

VaultFlush Event

Fires to flush a callback mode vault's data out to storage.


cbvault.on('VaultFlush', [callback])


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

function(e){ }

The argument 'e' has the following properties:



This event fires when the class needs to flush the data of the callback mode vault specified by VaultHandle out to storage.

This event only needs to be handled if the CallbackMode property is enabled; please refer to the Callback Mode topic for more information. To handle this event properly, applications must flush all data currently buffered for the vault specified by VaultHandle out to storage. For example, if the application is storing vault data in a file on disk, it could call FlushFileBuffers() on Windows.

The VaultHandle parameter contains an application-defined handle to an open callback mode vault, as returned by the application in an earlier VaultOpen event.

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) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Node.js Edition - Version 20.0 [Build 7922]