Progress Event

Fires to indicate the progress of long-running vault operations.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(CBVaultProgressEventParams *e);

typedef struct {
  int Operation;
  int Progress;
  int Total;
  int CanStop;
  int Stop;
  int reserved;
} CBVaultProgressEventParams;

Unicode (Windows)
virtual INT FireProgress(CBVaultProgressEventParams *e);

typedef struct {
  INT Operation;
  INT Progress;
  INT Total;
  BOOL CanStop;
  BOOL Stop;
  INT reserved;
} CBVaultProgressEventParams;

- (void)onProgress:(int)operation :(int)progress :(int)total :(BOOL)canStop :(int*)stop;

#define EID_CBVAULT_PROGRESS 9

virtual INT CBFSVAULT_CALL FireProgress(INT &iOperation, INT &iProgress, INT &iTotal, BOOL &bCanStop, BOOL &bStop);

Remarks

This event fires anytime the class needs to report the progress of a long-running vault operation. Certain operations may cause this event to fire repeatedly.

The Operation parameter specifies which long-running operation caused this event to fire. Possible values are:


CBFSSTORAGE_PO_FORMATTING	`0`	Formatting a vault.
CBFSSTORAGE_PO_CHECKING_1	`1`	Checking a vault (stage 1).
CBFSSTORAGE_PO_CHECKING_2	`2`	Checking a vault (stage 2).
CBFSSTORAGE_PO_CHECKING_3	`3`	Checking a vault (stage 3).
CBFSSTORAGE_PO_CHECKING_4	`4`	Checking a vault (stage 4).
CBFSSTORAGE_PO_CHECKING_5	`5`	Checking a vault (stage 5).
CBFSSTORAGE_PO_PAGE_CORRUPTED	`8`	Processing a corrupted vault page.
CBFSSTORAGE_PO_PAGE_ORPHANED	`9`	Processing an orphaned vault page.
CBFSSTORAGE_PO_COMPRESSING	`10`	Compressing a file or alternate stream.
CBFSSTORAGE_PO_DECOMPRESSING	`11`	Decompressing a file or alternate stream.
CBFSSTORAGE_PO_ENCRYPTING	`12`	Encrypting a vault, file, or alternate stream.
CBFSSTORAGE_PO_DECRYPTING	`13`	Decrypting a vault, file, or alternate stream
CBFSSTORAGE_PO_COMPACTING	`14`	Compacting a vault.
CBFSSTORAGE_PO_RESIZING	`15`	Resizing a vault.
CBFSSTORAGE_PO_CALCULATING_SIZE	`16`	Calculating a vault's size.
CBFSSTORAGE_PO_COPYING_FILES_TO_VAULT	`17`	Copying files to a vault.
CBFSSTORAGE_PO_COPYING_FILES_FROM_VAULT	`18`	Copying files from a vault.

The Progress and Total parameters reflect the current and maximum progress values. Both will be 0 if the operation's progression cannot be determined.

The CanStop parameter indicates whether the application may interrupt the operation by setting the Stop parameter to true. Note that some operations can only be interrupted at certain points over the course of their lifetime.

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.

CBFS Vault 2020 C++ Edition

Progress Event

Syntax

Remarks