CBFS Vault 2020 Python Edition

Questions / Feedback?

is_valid_vault Method

Checks whether a local file is a CBFS Vault vault.


def is_valid_vault() -> bool: ...


This method checks whether the file specified by the vault_file property is a CBFS Vault vault that can be opened by the class. The file being checked must be fully closed when this method is called.

If the specified file is a CBFS Vault vault, this method returns True; otherwise it returns False.

If the callback_mode property is enabled, the check will be performed via the appropriate Vault* events (and the value held by vault_file is simply passed to such events for the application to use).

Note that this method uses a simple detection mechanism; it doesn't perform a full consistency check or attempt any repairs, so applications may still need to call check_and_repair even if this method returns True. If an error occurs during the detection process, this method raises an exception.

Note: This method cannot be called when active is True, and cannot be called within events.

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