on_vault_delete Event

Fires to delete a callback mode vault.

Syntax

class CBDriveVaultDeleteEventParams(object):
  @property
  def vault() -> str: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

# In class CBDrive:
@property
def on_vault_delete() -> Callable[[CBDriveVaultDeleteEventParams], None]: ...
@on_vault_delete.setter
def on_vault_delete(event_hook: Callable[[CBDriveVaultDeleteEventParams], None]) -> None: ...

Remarks

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

This event only needs to be handled if the callback_mode 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 vault_file 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 class'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 class, the event will fire only in the first application. To prevent such a situation, always open a vault in read-write mode.