UseSystemCache Property

Whether the operating system's cache is used.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int GetUseSystemCache();
int SetUseSystemCache(int bUseSystemCache);

Unicode (Windows)
BOOL GetUseSystemCache();
INT SetUseSystemCache(BOOL bUseSystemCache);

@property (nonatomic,readwrite,assign,getter=useSystemCache,setter=setUseSystemCache:) BOOL useSystemCache;
- (BOOL)useSystemCache;
- (void)setUseSystemCache:(BOOL)newUseSystemCache;

#define PID_CBVAULT_USESYSTEMCACHE 19

CBFSSTORAGE_EXTERNAL void* CBFSSTORAGE_CALL CBFSStorage_CBVault_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CBFSSTORAGE_EXTERNAL int CBFSSTORAGE_CALL CBFSStorage_CBVault_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value

TRUE

Remarks

This property specifies whether the operating system's cache should be used. Use of the OS cache affects the speed of various vault operations; however, note that the exact effects depend on the type of operation as well as the data sizes involved.

For the CBVault class, disabling this property will cause a vault's storage file (specified by the VaultFile property) to be opened with FILE_FLAG_NO_BUFFERING (on Windows) or F_NOCACHE (on Linux/macOS). This also applies for the CBDrive class on Linux and macOS.

For the CBDrive class on Windows, a vault's storage file is always opened with FILE_FLAG_NO_BUFFERING regardless of how this property is set; disabling this property prevents the system cache from being used to cache files on the virtual drive. This may be necessary in certain situations in order to prevent BSODs. Please refer to Microsoft's File Caching article for more information about the system file cache.

Note: This property cannot be changed when Active is true, and cannot be changed within events.

Data Type

Boolean