VaultGetSize Event

Fires to determine the size of a callback mode vault.

Syntax

// CBDriveVaultGetSizeEventArgs carries the CBDrive VaultGetSize event's parameters.
type CBDriveVaultGetSizeEventArgs struct {...}

func (args *CBDriveVaultGetSizeEventArgs) VaultHandle() int64
func (args *CBDriveVaultGetSizeEventArgs) Size() int64
func (args *CBDriveVaultGetSizeEventArgs) SetSize(value int64)
func (args *CBDriveVaultGetSizeEventArgs) ResultCode() int32
func (args *CBDriveVaultGetSizeEventArgs) SetResultCode(value int32)

// CBDriveVaultGetSizeEvent defines the signature of the CBDrive VaultGetSize event's handler function.
type CBDriveVaultGetSizeEvent func(sender *CBDrive, args *CBDriveVaultGetSizeEventArgs)

func (obj *CBDrive) GetOnVaultGetSizeHandler() CBDriveVaultGetSizeEvent
func (obj *CBDrive) SetOnVaultGetSizeHandler(handlerFunc CBDriveVaultGetSizeEvent)

Remarks

This event fires when the component needs to determine the size of the callback mode vault specified by VaultHandle.

This event only needs to be handled if the CallbackMode property is enabled; please refer to the Callback Mode topic for more information. To handle this event properly, applications must set Size to indicate the size, in bytes, of the vault specified by VaultHandle.

The VaultHandle parameter contains an application-defined handle to an open callback mode vault, as returned by the application in an earlier VaultOpen 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 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.