VaultGetSize Event

Fires to determine the size of a callback mode vault.

Syntax

• C#
• VB.NET

public event OnVaultGetSizeHandler OnVaultGetSize;

public delegate void OnVaultGetSizeHandler(object sender, CbvaultVaultGetSizeEventArgs e);

public class CbvaultVaultGetSizeEventArgs : EventArgs {
  public long VaultHandle { get; }
  public long Size { get; set; }
  public int ResultCode { get; set; }
}

Public Event OnVaultGetSize As OnVaultGetSizeHandler

Public Delegate Sub OnVaultGetSizeHandler(sender As Object, e As CbvaultVaultGetSizeEventArgs)

Public Class CbvaultVaultGetSizeEventArgs Inherits EventArgs
  Public ReadOnly Property VaultHandle As Long
  Public Property Size As Long
  Public Property ResultCode As Integer
End Class

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.