Progress Event

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

Syntax

class CBDriveProgressEventParams {
public:
  int Operation();
  int Progress();
  int Total();
  bool CanStop();
  bool Stop();
  void SetStop(bool bStop);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Progress(CBDriveProgressEventParams *e);
// Or, subclass CBDrive and override this emitter function. virtual int FireProgress(CBDriveProgressEventParams *e) {...}

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_FORMATTING0Formatting a vault.

CBFSSTORAGE_PO_CHECKING_11Checking a vault (stage 1).

CBFSSTORAGE_PO_CHECKING_22Checking a vault (stage 2).

CBFSSTORAGE_PO_CHECKING_33Checking a vault (stage 3).

CBFSSTORAGE_PO_CHECKING_44Checking a vault (stage 4).

CBFSSTORAGE_PO_CHECKING_55Checking a vault (stage 5).

CBFSSTORAGE_PO_PAGE_CORRUPTED8Processing a corrupted vault page.

CBFSSTORAGE_PO_PAGE_ORPHANED9Processing an orphaned vault page.

CBFSSTORAGE_PO_COMPRESSING10Compressing a file or alternate stream.

CBFSSTORAGE_PO_DECOMPRESSING11Decompressing a file or alternate stream.

CBFSSTORAGE_PO_ENCRYPTING12Encrypting a vault, file, or alternate stream.

CBFSSTORAGE_PO_DECRYPTING13Decrypting a vault, file, or alternate stream

CBFSSTORAGE_PO_COMPACTING14Compacting a vault.

CBFSSTORAGE_PO_RESIZING15Resizing a vault.

CBFSSTORAGE_PO_CALCULATING_SIZE16Calculating a vault's size.

CBFSSTORAGE_PO_COPYING_FILES_TO_VAULT17Copying files to a vault.

CBFSSTORAGE_PO_COPYING_FILES_FROM_VAULT18Copying 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.

 
 
Copyright (c) 2020 Callback Technologies, Inc. - All rights reserved.
CBFS Storage 2020 Qt Edition - Version 20.0 [Build 7649]