Progress Event

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

Syntax

// CBVaultProgressEventArgs carries the CBVault Progress event's parameters.
type CBVaultProgressEventArgs struct {...}

func (args *CBVaultProgressEventArgs) Operation() int32
func (args *CBVaultProgressEventArgs) Progress() int32
func (args *CBVaultProgressEventArgs) Total() int32
func (args *CBVaultProgressEventArgs) CanStop() bool
func (args *CBVaultProgressEventArgs) Stop() bool
func (args *CBVaultProgressEventArgs) SetStop(value bool)

// CBVaultProgressEvent defines the signature of the CBVault Progress event's handler function.
type CBVaultProgressEvent func(sender *CBVault, args *CBVaultProgressEventArgs)

func (obj *CBVault) GetOnProgressHandler() CBVaultProgressEvent
func (obj *CBVault) SetOnProgressHandler(handlerFunc CBVaultProgressEvent)

Remarks

This event fires anytime the component 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.

Note: An application should not attempt to call component'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 component, the event will fire only in the first application. To prevent such a situation, always open a vault in read-write mode.

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