VaultClose Event

Fires to close a callback mode vault.

Syntax

// CBVaultVaultCloseEventArgs carries the CBVault VaultClose event's parameters.
type CBVaultVaultCloseEventArgs struct {...}

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

// CBVaultVaultCloseEvent defines the signature of the CBVault VaultClose event's handler function.
type CBVaultVaultCloseEvent func(sender *CBVault, args *CBVaultVaultCloseEventArgs)

func (obj *CBVault) GetOnVaultCloseHandler() CBVaultVaultCloseEvent
func (obj *CBVault) SetOnVaultCloseHandler(handlerFunc CBVaultVaultCloseEvent)

Remarks

This event fires when the component needs to close the callback mode vault specified by VaultHandle.

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 close the vault specified by VaultHandle, and invalidate the handle itself.

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]