VaultFlush Event

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

Syntax

// CBVaultVaultFlushEventArgs carries the CBVault VaultFlush event's parameters.
type CBVaultVaultFlushEventArgs struct {...}

func (args *CBVaultVaultFlushEventArgs) VaultHandle() int64
func (args *CBVaultVaultFlushEventArgs) ResultCode() int32
func (args *CBVaultVaultFlushEventArgs) SetResultCode(value int32)

// CBVaultVaultFlushEvent defines the signature of the CBVault VaultFlush event's handler function.
type CBVaultVaultFlushEvent func(sender *CBVault, args *CBVaultVaultFlushEventArgs)

func (obj *CBVault) GetOnVaultFlushHandler() CBVaultVaultFlushEvent
func (obj *CBVault) SetOnVaultFlushHandler(handlerFunc CBVaultVaultFlushEvent)

Remarks

This event fires when the component 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.

Note: An application should not attempt to call component's methods from handlers of this event. Doing this is guaranteed to cause a deadlock.

Note: when a storage is opened concurrently in read-only mode by several applications using CBDrive or CBMemDrive component, the event will fire only in the first application. To prevent such a situation, always open a vault in read-write mode.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS Vault 2020 Go Edition - Version 20.0 [Build 7982]