VaultDelete Event

Fires to delete a callback mode vault.

Syntax

// CBVaultVaultDeleteEventArgs carries the CBVault VaultDelete event's parameters.
type CBVaultVaultDeleteEventArgs struct {...}

func (args *CBVaultVaultDeleteEventArgs) Vault() string
func (args *CBVaultVaultDeleteEventArgs) ResultCode() int32
func (args *CBVaultVaultDeleteEventArgs) SetResultCode(value int32)

// CBVaultVaultDeleteEvent defines the signature of the CBVault VaultDelete event's handler function.
type CBVaultVaultDeleteEvent func(sender *CBVault, args *CBVaultVaultDeleteEventArgs)

func (obj *CBVault) GetOnVaultDeleteHandler() CBVaultVaultDeleteEvent
func (obj *CBVault) SetOnVaultDeleteHandler(handlerFunc CBVaultVaultDeleteEvent)

Remarks

This event fires when the component needs to delete the callback mode vault identified by Vault.

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 delete the vault identified by Vault.

The Vault parameter contains an application-defined vault identifier (name, file path, etc.). The value of this parameter will always match the current value of the VaultFile property.

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]