VaultWrite Event

Fires to write data to a callback mode vault.

Syntax

ANSI (Cross Platform)
virtual int FireVaultWrite(CBVaultVaultWriteEventParams *e);
typedef struct {
int64 VaultHandle;
int64 Offset;
const void *Buffer;
int Count;
int ResultCode; int reserved; } CBVaultVaultWriteEventParams; Unicode (Windows) virtual INT FireVaultWrite(CBVaultVaultWriteEventParams *e);
typedef struct {
LONG64 VaultHandle;
LONG64 Offset;
LPCVOID Buffer;
INT Count;
INT ResultCode; INT reserved; } CBVaultVaultWriteEventParams;
- (void)onVaultWrite:(long long)vaultHandle :(long long)offset :(const void*)buffer :(int)count :(int*)resultCode;
#define EID_CBVAULT_VAULTWRITE 18

virtual INT CBFSVAULT_CALL FireVaultWrite(LONG64 &lVaultHandle, LONG64 &lOffset, LPVOID &lpBuffer, INT &iCount, INT &iResultCode);

Remarks

This event fires when the class needs to write data to 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 write Count bytes of data from Buffer to the vault specified by VaultHandle, starting at the specified Offset in the vault.

Count is always a multiple of the vault's PageSize. If, for any reason, an application cannot write exactly Count bytes of data to the vault, it must return an appropriate error code via ResultCode.

Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

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

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