on_vault_flush Event

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

Syntax

class CBDriveVaultFlushEventParams(object):
  @property
  def vault_handle() -> int: ...
  @property
  def result_code() -> int: ...
  @result_code.setter
  def result_code(value) -> None: ...

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

Remarks

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 callback_mode 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 on_vault_open 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 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.