ReadOnly Property

Whether the class should open a vault in read-only mode.


ANSI (Cross Platform)
int GetReadOnly();
int SetReadOnly(int bReadOnly); Unicode (Windows) BOOL GetReadOnly();
INT SetReadOnly(BOOL bReadOnly);
@property (nonatomic,readwrite,assign,getter=readOnly,setter=setReadOnly:) BOOL readOnly;
- (BOOL)readOnly;
- (void)setReadOnly:(BOOL)newReadOnly;

CBFSVAULT_EXTERNAL void* CBFSVAULT_CALL CBFSVault_CBVault_Get(void *lpObj, int propid, int arridx, int *lpcbVal, int64 *lpllVal);
CBFSVAULT_EXTERNAL int CBFSVAULT_CALL CBFSVault_CBVault_Set(void *lpObj, int propid, int arridx, const void *val, int cbVal);

Default Value



This property specifies whether the class should open a vault in read-only mode. When a vault is open in read-only mode, the following restrictions apply:

  • No new vault items (files, directories, symbolic links, and alternate streams) may be created.
  • No existing vault items may be modified, renamed, moved, or deleted. (This includes updating access times.)
  • The vault cannot be resized or compacted (automatically or explicitly).
  • Vault corruption cannot be repaired using CheckAndRepair.
(Note that this list may not necessarily be exhaustive.)

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

Data Type


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