CBVaultDrive Module

Properties   Methods   Events   Config Settings   Errors  

The CBVaultDrive module lets applications create a vault, manipulate its contents, and mount it as a virtual drive.

Syntax

CBFSStorage.CBVaultDrive

Remarks

The CBVaultDrive class provides a superset of the functionality offered by the CBVAULT class. In addition to allowing applications to create and interact with a vault directly, the CBVaultDrive class can mount a vault as a virtual drive, allowing its contents to be accessed by the system and third-party applications.

Unlike the CBVAULT class, which can be used as-is, the CBVaultDrive class requires additional deployment steps; please refer to the Windows-specific deployment topics deployment topics for more information. For more information about using CBFS Storage's many features, please refer to the extensive General Information topics.

Getting Started

Each CBVaultDrive class instance controls a single vault-based virtual drive. Applications can use multiple instances of the CBVaultDrive class if their use-case requires that multiple vaults be mounted simultaneously.

Here's how to get up and running:

1. Ensure that the required Prerequisites have been satisfied. On Windows, for example, this involves installing the system driver, which can be done using the Install method.
2. Call the Initialize method to initialize the CBVaultDrive class. This must be done each time the application starts (if the application is using multiple CBVaultDrive class instances, only the first instance created should be used to call Initialize).
3. If the application is using custom compression, custom encryption, or callback mode, ensure that the appropriate event handlers have been implemented. Please refer to the linked topics for more information.
4. Call the OpenVault method to create/open a vault and mount it as a virtual drive.
5. Create one or more Mounting Points for the virtual drive using the AddMountingPoint method.
6. At this point, the system and other processes will be able to access the vault's contents via the virtual drive.
7. Later, the application can close the vault and unmount the associated virtual drive by calling the CloseVault method.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

AccessDeniedProcesses Property (CBVaultDrive Module)

Collection of access rules that define which processes may not access the virtual drive.

Syntax

• Swift
• Objective-C

public var accessDeniedProcesses: Array<ProcessAccessRule> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=accessDeniedProcessCount) int accessDeniedProcessCount;

- (int)accessDeniedProcessCount;

- (int)accessDeniedProcessDesiredAccess:(int)accessDeniedProcessIndex;

- (BOOL)accessDeniedProcessIncludeChildren:(int)accessDeniedProcessIndex;

- (int)accessDeniedProcessId:(int)accessDeniedProcessIndex;

- (NSString*)accessDeniedProcessName:(int)accessDeniedProcessIndex;

Default Value

0

Remarks

This property holds a collection of ProcessAccessRule objects representing rules that deny processes certain kinds of access to the virtual drive.

Please refer to the AddDeniedProcess and RemoveDeniedProcess methods for more information.

Note: The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

This property is read-only.

AccessGrantedProcesses Property (CBVaultDrive Module)

Collection of access rules that define which processes may access the virtual drive.

Syntax

• Swift
• Objective-C

public var accessGrantedProcesses: Array<ProcessAccessRule> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=accessGrantedProcessCount) int accessGrantedProcessCount;

- (int)accessGrantedProcessCount;

- (int)accessGrantedProcessDesiredAccess:(int)accessGrantedProcessIndex;

- (BOOL)accessGrantedProcessIncludeChildren:(int)accessGrantedProcessIndex;

- (int)accessGrantedProcessId:(int)accessGrantedProcessIndex;

- (NSString*)accessGrantedProcessName:(int)accessGrantedProcessIndex;

Default Value

0

Remarks

This property holds a collection of ProcessAccessRule objects representing rules that grant processes certain kinds of access to the virtual drive.

Please refer to the AddGrantedProcess and RemoveGrantedProcess methods for more information.

Note: The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

This property is read-only.

Active Property (CBVaultDrive Module)

Whether a vault has been opened and mounted as a virtual drive.

Syntax

• Swift
• Objective-C

public var active: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=active) BOOL active;

- (BOOL)active;

Default Value

False

Remarks

This property reflects whether the class has opened a vault and mounted a virtual drive for it; it will be once the OpenVault or OpenVolume method has been called successfully.

This property is read-only.

AutoCompactAt Property (CBVaultDrive Module)

This property specifies the free space percentage threshold a vault must reach to be eligible for automatic compaction.

Syntax

• Swift
• Objective-C

public var autoCompactAt: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=autoCompactAt,setter=setAutoCompactAt:) int autoCompactAt;

- (int)autoCompactAt;
- (void)setAutoCompactAt :(int)newAutoCompactAt;

Default Value

25

Remarks

This property specifies the percentage of free space a vault must have, at minimum, for it to be eligible for automatic vault compaction. An eligible vault may be compacted automatically in the background at any time. Please refer to the CompactVault method for more information about the compacting process.

To guard against excessive automatic compaction operations, applications can set the AutoCompactDelay configuration setting to a nonzero value. Alternatively, this property can be set to 0 to disable automatic compaction completely.

A vault opened in ReadOnly mode will never be compacted, regardless of this property's value.

Note: This property cannot be changed within events.

CallbackMode Property (CBVaultDrive Module)

This property specifies whether the module should operate in callback mode.

Syntax

• Swift
• Objective-C

public var callbackMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=callbackMode,setter=setCallbackMode:) BOOL callbackMode;

- (BOOL)callbackMode;
- (void)setCallbackMode :(BOOL)newCallbackMode;

Default Value

False

Remarks

This property specifies whether the class should operate in callback mode, causing all vault access to be performed through the following events. Please refer to the Callback Mode topic for more information.

When this property is enabled, the following events must all be implemented for the class to function correctly:

• VaultClose
• VaultDelete
• VaultFlush
• VaultGetParentSize
• VaultGetSize
• VaultOpen
• VaultRead
• VaultSetSize
• VaultWrite

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

CaseSensitive Property (CBVaultDrive Module)

This property specifies whether the module should open a vault in case-sensitive mode.

Syntax

• Swift
• Objective-C

public var caseSensitive: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=caseSensitive,setter=setCaseSensitive:) BOOL caseSensitive;

- (BOOL)caseSensitive;
- (void)setCaseSensitive :(BOOL)newCaseSensitive;

Default Value

False

Remarks

This property specifies whether the class should open a vault in case-sensitive mode. Enabling this property causes all file, directory, symbolic link, alternate stream, and file tag names to be treated as case sensitive.

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

DefaultFileAccessPassword Property (CBVaultDrive Module)

This property specifies the default encryption password to use when opening files and alternate streams.

Syntax

• Swift
• Objective-C

public var defaultFileAccessPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultFileAccessPassword,setter=setDefaultFileAccessPassword:) NSString* defaultFileAccessPassword;

- (NSString*)defaultFileAccessPassword;
- (void)setDefaultFileAccessPassword :(NSString*)newDefaultFileAccessPassword;

Default Value

""

Remarks

This property specifies the default encryption password that the class should use when opening files and alternate streams.

Please refer to the Encryption topic for more information.

As an alternative to using this property, applications may call the CacheFilePassword method (before a file is opened) to specify a one-time-use password or may specify file encryption passwords dynamically using the FilePasswordNeeded event.

DefaultFileCompression Property (CBVaultDrive Module)

This property specifies the default compression mode to use when creating files and alternate streams.

Syntax

• Swift
• Objective-C

public var defaultFileCompression: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultFileCompression,setter=setDefaultFileCompression:) int defaultFileCompression;

- (int)defaultFileCompression;
- (void)setDefaultFileCompression :(int)newDefaultFileCompression;

Default Value

0

Remarks

This property specifies the default compression mode that the class should use when creating files and alternate streams. Valid values are as follows:

Applications that use custom compression must implement the DataCompress and DataDecompress events. Please refer to the Compression topic for more information.

Applications can also specify a default compression level using the DefaultFileCompressionLevel configuration setting, if desired.

DefaultFileCreatePassword Property (CBVaultDrive Module)

This property specifies the default encryption password to use when creating new files and alternate streams.

Syntax

• Swift
• Objective-C

public var defaultFileCreatePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultFileCreatePassword,setter=setDefaultFileCreatePassword:) NSString* defaultFileCreatePassword;

- (NSString*)defaultFileCreatePassword;
- (void)setDefaultFileCreatePassword :(NSString*)newDefaultFileCreatePassword;

Default Value

""

Remarks

This property specifies the default encryption password that the class should use when creating new files and alternate streams.

Please refer to the Encryption topic for more information.

DefaultFileEncryption Property (CBVaultDrive Module)

This property specifies the default encryption mode to use when creating files and alternate streams.

Syntax

• Swift
• Objective-C

public var defaultFileEncryption: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultFileEncryption,setter=setDefaultFileEncryption:) int defaultFileEncryption;

- (int)defaultFileEncryption;
- (void)setDefaultFileEncryption :(int)newDefaultFileEncryption;

Default Value

0

Remarks

This property specifies the default encryption mode that the class should use when creating files and alternate streams. Valid values are as follows:

Applications that use custom encryption must implement at least the DataEncrypt and DataDecrypt events. Certain custom encryption modes may require that the HashCalculate or KeyDerive event be implemented as well. Please refer to the Encryption topic for more information.

Applications that set this property to a value other than VAULT_EM_NONE (the default) should also specify a default encryption password using the DefaultFileCreatePassword property.

FileSystemName Property (CBVaultDrive Module)

The name of the virtual filesystem.

Syntax

• Swift
• Objective-C

public var fileSystemName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fileSystemName,setter=setFileSystemName:) NSString* fileSystemName;

- (NSString*)fileSystemName;
- (void)setFileSystemName :(NSString*)newFileSystemName;

Default Value

"FAT32"

Remarks

This property specifies the name of the virtual filesystem. Windows, and some other applications, use this name to identify the filesystem.

In general, the filesystem name can be any reasonable string up to 10 characters in length. However, some versions of Windows and some third-party programs may behave differently when they encounter an unknown filesystem name (i.e., anything other than FAT, FAT32, exFAT, NTFS, etc.). Applications should keep this restriction in mind when choosing a filesystem name.

This property is set to FAT32 by default, which may cause some applications to fail when attempting to copy large (>4GB) files to and from the virtual drive. It is recommended that applications set this property to exFAT if such issues occur.

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

IsCorrupted Property (CBVaultDrive Module)

This property specifies whether the vault is corrupted.

Syntax

• Swift
• Objective-C

public var isCorrupted: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=isCorrupted) BOOL isCorrupted;

- (BOOL)isCorrupted;

Default Value

False

Remarks

This property reflects whether the currently open vault is corrupted, as indicated by the presence of the VAULT_ST_CORRUPTED flag in the VaultState property.

The VAULT_ST_CORRUPTED flag is set automatically anytime the class detects that a vault's integrity has been compromised. Calling the CheckAndRepair method for a corrupted vault will clear the flag.

This property is read-only.

LastWriteTime Property (CBVaultDrive Module)

This property specifies the last modification time of the vault.

Syntax

• Swift
• Objective-C

public var lastWriteTime: Date {
  get {...}
}

@property (nonatomic,readonly,assign,getter=lastWriteTime) NSDate* lastWriteTime;

- (NSDate*)lastWriteTime;

Default Value

0

Remarks

This property reflects the vault's last modification time, specified .

This property is read-only.

Logo Property (CBVaultDrive Module)

This property specifies an application-defined text-based logo stored in the second page of a vault.

Syntax

• Swift
• Objective-C

public var logo: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=logo,setter=setLogo:) NSString* logo;

- (NSString*)logo;
- (void)setLogo :(NSString*)newLogo;

Default Value

"CBFS Vault"

Remarks

This property is used to control a vault's logo, which is a UTF-16LE string stored in the second page of a vault. A vault's logo is visible to anyone who inspects its raw data and thus can be used to provide information about the vault itself.

Vault logos can be up to 127 characters long (not including the null terminator).

Note: This property cannot be changed within events.

MountingPoints Property (CBVaultDrive Module)

Collection of mounting points for the virtual drive.

Syntax

• Swift
• Objective-C

public var mountingPoints: Array<MountingPoint> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=mountingPointCount) int mountingPointCount;

- (int)mountingPointCount;

- (long long)mountingPointAuthenticationId:(int)mountingPointIndex;

- (int)mountingPointFlags:(int)mountingPointIndex;

- (NSString*)mountingPointName:(int)mountingPointIndex;

Default Value

0

Remarks

This property holds a collection of MountingPoint objects, each of which represents an available mounting point for the virtual drive.

Please refer to the AddMountingPoint and RemoveMountingPoint methods for more information.

Note: The methods and properties related to mounting points are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of mounting points occurs in a thread-safe manner.

This property is read-only.

OpenFiles Property (CBVaultDrive Module)

Collection of information about the objects in the virtual drive that are currently open.

Syntax

• Swift
• Objective-C

public var openFiles: Array<OpenFile> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=openFilesCount) int openFilesCount;

- (int)openFilesCount;

- (NSString*)openFileName:(int)openFileIndex;

- (int)openFileProcessId:(int)openFileIndex;

- (NSString*)openFileProcessName:(int)openFileIndex;

Default Value

0

Remarks

This property holds a collection of OpenFile objects representing filesystem objects (files, directories, etc.) from the virtual drive that are currently open. The collection is populated anytime CreateOpenedFilesSnapshot is called, and cleared when CloseOpenedFilesSnapshot is called; please refer to those methods for more information.

Note: The methods and properties related to open files snapshots are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that creation, use, and cleanup of open files snapshots occurs in a thread-safe manner.

This property is read-only.

PageSize Property (CBVaultDrive Module)

This property specifies the vault's page size.

Syntax

• Swift
• Objective-C

public var pageSize: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=pageSize,setter=setPageSize:) int pageSize;

- (int)pageSize;
- (void)setPageSize :(int)newPageSize;

Default Value

4096

Remarks

This property controls the page size used when creating new vaults and reflects the page size of the currently open vault. Valid values are 256 through 65536 bytes (inclusive).

A vault's page size is permanent, it cannot be changed after the vault is created. Please refer to the Vaults topic for more information.

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

PathSeparator Property (CBVaultDrive Module)

This property specifies the path separator character to use when returning vault paths.

Syntax

• Swift
• Objective-C

public var pathSeparator: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=pathSeparator,setter=setPathSeparator:) int pathSeparator;

- (int)pathSeparator;
- (void)setPathSeparator :(int)newPathSeparator;

Default Value

92

Remarks

This property specifies the path separator character that the class APIs should use when returning a vault path. Valid values are as follows:

Note: This property is just a convenience; applications are free to use either of the above characters as path separators when passing path strings to the class's APIs.

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

PossibleFreeSpace Property (CBVaultDrive Module)

This property specifies the maximum amount of free space the vault could possibly have available.

Syntax

• Swift
• Objective-C

public var possibleFreeSpace: Int64 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=possibleFreeSpace) long long possibleFreeSpace;

- (long long)possibleFreeSpace;

Default Value

0

Remarks

This property reflects the maximum amount of free space, in bytes, that the vault could possibly have available. That is, it is the amount of free space that would be available if the vault automatically grew to its maximum PossibleSize right now, without any additional data being written to it. Therefore:

• If VaultSizeMax is 0 (unlimited): this property is equivalent to VaultFreeSpace + parent_free_space.
• If VaultSizeMax is not 0: this property is equivalent to VaultFreeSpace + min(parent_free_space, (VaultSizeMax - VaultSize)).

In both cases, parent_free_space is the amount of free space available for the vault to use for automatic growth. For a file-based vault, this is the total amount of free space on the disk where the vault's storage file (i.e., VaultFile) resides, as reported by the OS. For a Callback Mode vault, this is whatever value the application provides through the VaultGetParentSize event.

Please refer to the Vault Size topic for more information.

This property is read-only.

PossibleSize Property (CBVaultDrive Module)

This property specifies the maximum size the vault could possibly be.

Syntax

• Swift
• Objective-C

public var possibleSize: Int64 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=possibleSize) long long possibleSize;

- (long long)possibleSize;

Default Value

0

Remarks

This property reflects the maximum size, in bytes, that the vault could possibly be. That is, it is the size that the vault would be if it automatically grew as much as possible right now, without any additional data being written to it. Therefore:

• If VaultSizeMax is 0 (unlimited): this property is equivalent to VaultFreeSpace + parent_free_space.
• If VaultSizeMax is not 0: this property matches VaultSizeMax.

In the former case, parent_free_space is the amount of free space available for the vault to use for automatic growth. For a file-based vault, this is the total amount of free space on the disk where the vault's storage file (i.e., VaultFile) resides, as reported by the OS. For a Callback Mode vault, this is whatever value the application provides through the VaultGetParentSize event.

Please refer to the VaultSize topic for more information.

This property is read-only.

ProcessRestrictionsEnabled Property (CBVaultDrive Module)

Whether process access restrictions are enabled.

Syntax

• Swift
• Objective-C

public var processRestrictionsEnabled: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=processRestrictionsEnabled,setter=setProcessRestrictionsEnabled:) BOOL processRestrictionsEnabled;

- (BOOL)processRestrictionsEnabled;
- (void)setProcessRestrictionsEnabled :(BOOL)newProcessRestrictionsEnabled;

Default Value

False

Remarks

This property controls whether the class should enforce per-process access restrictions; by default, it is disabled. When enabled, the AddGrantedProcess and AddDeniedProcess methods can be used to add process-specific access rules for the class to enforce across the entire virtual drive.

When an application enables this propery, it should use the AddGrantedProcess method to add at least one pocess as allowed; otherwise, the data will be inaccessible.

The current process access rules are reflected by the AccessGrantedProcess* and AccessDeniedProcess* properties.

Note: The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

ReadOnly Property (CBVaultDrive Module)

This property specifies whether the module should open a vault in read-only mode.

Syntax

• Swift
• Objective-C

public var readOnly: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=readOnly,setter=setReadOnly:) BOOL readOnly;

- (BOOL)readOnly;
- (void)setReadOnly :(BOOL)newReadOnly;

Default Value

False

Remarks

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

• No new vault items (e.g., 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: This list may not necessarily be exhaustive.

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

ReportPossibleSize Property (CBVaultDrive Module)

How the module should report the virtual drive's size and free space to the OS.

Syntax

• Swift
• Objective-C

public var reportPossibleSize: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=reportPossibleSize,setter=setReportPossibleSize:) BOOL reportPossibleSize;

- (BOOL)reportPossibleSize;
- (void)setReportPossibleSize :(BOOL)newReportPossibleSize;

Default Value

True

Remarks

This property controls which pair of values the class should use when reporting the virtual drive's size and free space to the OS.

When this property is enabled (default), the class will use the values of the PossibleSize and PossibleFreeSpace properties. When this property is disabled, the class will use the values of the VaultSize and PossibleSize properties.

To ensure correct operation, it is recommended that applications keep this property enabled, unless a vault's size has been fixed by setting the VaultSizeMin and VaultSizeMax properties equal to each other.

Please refer to the documentation of the properties mentioned above, as well as the Vault Size topic, for more information.

Note: This property cannot be changed within events.

SerializeEvents Property (CBVaultDrive Module)

Whether events should be fired on a single worker thread, or many.

Syntax

• Swift
• Objective-C

public var serializeEvents: CBVaultDriveSerializeEvents {
  get {...}
  set {...}
}

public enum CBVaultDriveSerializeEvents: Int32 {
  case seOnMultipleThreads = 0
  case seOnOneWorkerThread = 1
}

@property (nonatomic,readwrite,assign,getter=serializeEvents,setter=setSerializeEvents:) int serializeEvents;

- (int)serializeEvents;
- (void)setSerializeEvents :(int)newSerializeEvents;

Default Value

0

Remarks

This property specifies whether the class should fire all events serially on a single worker thread, or concurrently on multiple worker threads. The possible values are:

Please refer to the Threading and Concurrency topic for more information.

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

StorageCharacteristics Property (CBVaultDrive Module)

The characteristic flags to create the virtual drive with (Windows only).

Syntax

• Swift
• Objective-C

public var storageCharacteristics: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=storageCharacteristics,setter=setStorageCharacteristics:) int storageCharacteristics;

- (int)storageCharacteristics;
- (void)setStorageCharacteristics :(int)newStorageCharacteristics;

Default Value

16

Remarks

The system, as well as other applications, use these flags to optimize their use of the virtual drive. This property should be set by OR'ing together zero or more of the following flags:

Note: This property cannot be changed after a virtual drive is created, and it cannot be changed within events.

StorageGUID Property (CBVaultDrive Module)

The GUID to create the virtual drive with.

Syntax

• Swift
• Objective-C

public var storageGUID: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=storageGUID,setter=setStorageGUID:) NSString* storageGUID;

- (NSString*)storageGUID;
- (void)setStorageGUID :(NSString*)newStorageGUID;

Default Value

""

Remarks

When the StorageType property is set to STGT_DISK_PNP, this property is used to specify a GUID for the virtual drive, and must be set to GUID-formatted string (e.g., {676D0357-A23A-49c3-B433-65AAD72DD282}). Otherwise, this property may be left empty; in the latter case, the driver will generate a unique value when a drive is mounted.

Some software uses a drive's GUID for the purpose of setting and maintaining certain configuration parameters. Therefore, applications are expected to use the same GUID when repeatedly creating a virtual drive that represents the same data.

Note: This property cannot be changed after a virtual drive is created, and it cannot be changed within events.

StorageType Property (CBVaultDrive Module)

The type of virtual drive to create (Windows only).

Syntax

• Swift
• Objective-C

public var storageType: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=storageType,setter=setStorageType:) int storageType;

- (int)storageType;
- (void)setStorageType :(int)newStorageType;

Default Value

0

Remarks

This property specifies what type of virtual drive should be created. Windows File Explorer uses this information to display the appropriate icon and apply the appropriate security settings for the virtual drive. Other applications may also make use of this information in various ways.

Possible values are:

Note: This property cannot be changed after a virtual drive is created, and it cannot be changed within events.

Plug-and-play Virtual Drives

Virtual drives created as plug-and-play (STGT_DISK_PNP) require that a "physical device" be visible in the Disk Manager snap-in of the Microsoft Management Console (mmc.exe). This can be accomplished by calling the AddMountingPoint method and including the STGMP_MOUNT_MANAGER flag in the value passed for its Flags parameter.

In addition to supporting the STGC_REMOVABLE_MEDIA StorageCharacteristics flag, which specifies whether a virtual drive's media is removable or non-removable, plug-and-play virtual drives also support the STGC_ALLOW_EJECTION flag, which specifies whether a virtual drive itself is removable or non-removable.

Tag Property (CBVaultDrive Module)

This property stores application-defined data specific to a particular instance of the module.

Syntax

• Swift
• Objective-C

public var tag: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=tag,setter=setTag:) long long tag;

- (long long)tag;
- (void)setTag :(long long)newTag;

Default Value

0

Remarks

This property can be used to store data specific to a particular instance of the class.

Timeout Property (CBVaultDrive Module)

How long vault events may execute before timing out (Windows only).

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

Default Value

0

Remarks

When an application is operating in Callback Mode, this property specifies how long the Vault* events may execute before timing out.

When this property is set to a non-zero value, and a Vault* event executes long enough for its timeout to expire, the driver cancels the underlying request by reporting an error to the OS. The tardy event still runs to completion, but any results it returns once finished are ignored since the underlying request has already been handled.

Setting this property to 0 disables event timeouts, which allows Vault* events to take as long as necessary to execute.

Note: This property cannot be changed within events.

UnmountOnTermination Property (CBVaultDrive Module)

Whether the virtual drive should be unmounted if the application terminates (Windows only).

Syntax

• Swift
• Objective-C

public var unmountOnTermination: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=unmountOnTermination,setter=setUnmountOnTermination:) BOOL unmountOnTermination;

- (BOOL)unmountOnTermination;
- (void)setUnmountOnTermination :(BOOL)newUnmountOnTermination;

Default Value

True

Remarks

This property specifies whether the CBFS Storage driver should automatically unmount the virtual drive (closing all handles and other resources associated with it) if the application terminates.

If this property is disabled, applications may need to call the ForceUnmount method after a crash (if there was a file-based vault open and mounted as a virtual drive when the crash occurred).

Note: This property cannot be disabled on non-Windows platforms.

UseAccessTime Property (CBVaultDrive Module)

This property specifies whether the module should keep track of last access times for vault items.

Syntax

• Swift
• Objective-C

public var useAccessTime: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=useAccessTime,setter=setUseAccessTime:) BOOL useAccessTime;

- (BOOL)useAccessTime;
- (void)setUseAccessTime :(BOOL)newUseAccessTime;

Default Value

False

Remarks

This property specifies whether the class should update the last access time for vault items (e.g., files, directories, symbolic links, and alternate streams) every time they are accessed.

Note: Keeping track of access times will slow down operations.

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

UseSystemCache Property (CBVaultDrive Module)

This property specifies whether the operating system's cache is used.

Syntax

• Swift
• Objective-C

public var useSystemCache: Bool {
  get {...}
  set {...}
}

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

- (BOOL)useSystemCache;
- (void)setUseSystemCache :(BOOL)newUseSystemCache;

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, 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 CBVaultDrive class on Linux and macOS.

For the CBVaultDrive 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 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 , and it cannot be changed within events.

VaultEncryption Property (CBVaultDrive Module)

This property specifies the whole-vault encryption mode.

Syntax

• Swift
• Objective-C

public var vaultEncryption: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vaultEncryption,setter=setVaultEncryption:) int vaultEncryption;

- (int)vaultEncryption;
- (void)setVaultEncryption :(int)newVaultEncryption;

Default Value

0

Remarks

This property controls the whole-vault encryption mode used when creating new vaults and reflects the whole-vault encryption mode of the currently open vault. Valid values are as follows:

Applications that use custom encryption must implement at least the DataEncrypt and DataDecrypt events. Certain custom encryption modes may require that the HashCalculate or KeyDerive event be implemented as well. Please refer to the Encryption topic for more information.

To create a new vault with whole-vault encryption enabled, the VaultPassword property must be set as well.

When an existing vault is opened, the class updates VaultEncryption automatically based on the detected whole-vault encryption mode. If the vault is encrypted, the class will attempt to access it using the password specified by VaultPassword. If VaultPassword is incorrect, the attempt will fail and the vault will not be opened.

The VaultEncryption and VaultPassword properties cannot be used to change an open vault's whole-vault encryption mode or password; use the UpdateVaultEncryption method.

Please refer to the Encryption topic for more information.

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

VaultFile Property (CBVaultDrive Module)

This property specifies the vault to create or open.

Syntax

• Swift
• Objective-C

public var vaultFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vaultFile,setter=setVaultFile:) NSString* vaultFile;

- (NSString*)vaultFile;
- (void)setVaultFile :(NSString*)newVaultFile;

Default Value

""

Remarks

This property specifies the vault to create or open when the OpenVault method is called.

When the CallbackMode property is disabled (default), this property specifies the vault storage file to create or open. It must be set to a fully qualified file path formatted according to OS conventions.

When the CallbackMode property is enabled, this property is only used to populate the Vault parameter of the VaultOpen, VaultGetParentSize, and VaultDelete events; and can be set to any application-defined value. Please refer to the Callback Mode topic for more information.

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

VaultFreeSpace Property (CBVaultDrive Module)

This property reflects the actual amount of free space the vault has available.

Syntax

• Swift
• Objective-C

public var vaultFreeSpace: Int64 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=vaultFreeSpace) long long vaultFreeSpace;

- (long long)vaultFreeSpace;

Default Value

0

Remarks

This property reflects the actual amount of free space, in bytes, that the vault currently has available. A vault's actual free space is based on its actual size, which is reflected by the VaultSize property.

Applications can also determine the maximum amount of free space the vault could possibly have by querying the PossibleFreeSpace property; please refer to its documentation, as well as the Vault Size topic, for more information.

This property is read-only.

VaultPassword Property (CBVaultDrive Module)

This property specifies the whole-vault encryption password.

Syntax

• Swift
• Objective-C

public var vaultPassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vaultPassword,setter=setVaultPassword:) NSString* vaultPassword;

- (NSString*)vaultPassword;
- (void)setVaultPassword :(NSString*)newVaultPassword;

Default Value

""

Remarks

This property specifies the whole-vault encryption password to use when creating new vaults and opening existing vaults.

To create a new vault with whole-vault encryption enabled, the VaultEncryption property must be set as well.

When an existing vault is opened, the class updates VaultEncryption automatically based on the detected whole-vault encryption mode. If the vault is encrypted, the class will attempt to access it using the password specified by VaultPassword. If VaultPassword is incorrect, the attempt will fail and the vault will not be opened.

The VaultEncryption and VaultPassword properties cannot be used to change an open vault's whole-vault encryption mode or password; use the UpdateVaultEncryption method.

Please refer to the Encryption topic for more information.

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

VaultSize Property (CBVaultDrive Module)

This property specifies the actual size of the vault.

Syntax

• Swift
• Objective-C

public var vaultSize: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vaultSize,setter=setVaultSize:) long long vaultSize;

- (long long)vaultSize;
- (void)setVaultSize :(long long)newVaultSize;

Default Value

0

Remarks

This property specifies the actual size of the vault, in bytes.

Applications may use this property to explicitly resize a vault, keeping in mind the following:

• A vault cannot shrink more than its available free space allows (i.e., not by more than VaultFreeSpace bytes).
• A vault cannot shrink beyond VaultSizeMin bytes.
• If VaultSizeMax is not 0 (unlimited), a vault cannot grow beyond VaultSizeMax bytes.
• If a vault grows enough to reach or exceed its AutoCompactAt threshold, it will automatically shrink again when the next automatic compaction occurs.

Applications can determine the maximum size a vault could possibly be by querying the PossibleSize property. Please refer to the Vault Size topic for more information.

Note: This property can be changed only when Active is , and it cannot be changed within events.

VaultSizeMax Property (CBVaultDrive Module)

This property specifies the maximum size a vault can be.

Syntax

• Swift
• Objective-C

public var vaultSizeMax: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vaultSizeMax,setter=setVaultSizeMax:) long long vaultSizeMax;

- (long long)vaultSizeMax;
- (void)setVaultSizeMax :(long long)newVaultSizeMax;

Default Value

0

Remarks

This property specifies the maximum size, in bytes, that a vault can be. This property must be set to 0 (unlimited), or a number greater than or equal to 8 * PageSize or VaultSizeMin (whichever is greater).

The limit imposed by this property, if any, applies to both explicit growth of a vault via the VaultSize property, and implicit growth of a vault due to storage load. Please refer to the Vault Size topic for more information.

Note: This property cannot be changed within events.

VaultSizeMin Property (CBVaultDrive Module)

This property specifies the minimum size a vault can be.

Syntax

• Swift
• Objective-C

public var vaultSizeMin: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=vaultSizeMin,setter=setVaultSizeMin:) long long vaultSizeMin;

- (long long)vaultSizeMin;
- (void)setVaultSizeMin :(long long)newVaultSizeMin;

Default Value

0

Remarks

This property specifies the minimum size, in bytes, that a vault can be. This property's value must be less than or equal to VaultSizeMax, unless VaultSizeMax is set to 0 (unlimited).

The limit imposed by this property applies to both explicit shrinking of a vault via the VaultSize property or the CompactVault method, and implicit shrinking of a vault via automatic compaction. Please refer to the Vault Size topic for more information.

Note: This property cannot be changed within events.

VaultState Property (CBVaultDrive Module)

This property specifies information about the state of the vault.

Syntax

• Swift
• Objective-C

public var vaultState: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=vaultState) int vaultState;

- (int)vaultState;

Default Value

0

Remarks

This property reflects the current state of the vault; its value consists of one or more of the following flags, ORed together:

This property is read-only.

AddDeniedProcess Method (CBVaultDrive Module)

Adds a rule that prevents a process from accessing the virtual drive.

Syntax

• Swift
• Objective-C

public func addDeniedProcess(processFileName: String, processId: Int32, childProcesses: Bool, desiredAccess: Int32) throws -> Void

- (void)addDeniedProcess:(NSString*)processFileName :(int)processId :(BOOL)childProcesses :(int)desiredAccess;

Remarks

When the ProcessRestrictionsEnabled property is enabled, this method can be used to add an access rule that denies the process specified by ProcessFileName or ProcessId the access right specified by DesiredAccess.

Processes that are already running can be specified by passing their process Id (PID) for the ProcessId parameter (in which case ProcessFileName should be empty). Processes that have not yet started can be specified by passing the full file name of the process's executable file for ProcessFileName (in which case ProcessId should be set to 0). If ProcessName is empty, and ProcessId is -1, the new rule will apply to all processes. When adding a PID-based rule, you need to be aware of the PID Reuse behavior of Windows.

ChildProcesses controls whether the rule also applies to children of the target process.

DesiredAccess specifies the access right to deny; valid values are:

To remove the process access rule later, pass the same ProcessFileName and ProcessId values to the RemoveDeniedProcess method.

Note: This method can be called only when Active is , and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

AddGrantedProcess Method (CBVaultDrive Module)

Adds a rule that allows a process to access the virtual drive.

Syntax

• Swift
• Objective-C

public func addGrantedProcess(processFileName: String, processId: Int32, childProcesses: Bool, desiredAccess: Int32) throws -> Void

- (void)addGrantedProcess:(NSString*)processFileName :(int)processId :(BOOL)childProcesses :(int)desiredAccess;

Remarks

When the ProcessRestrictionsEnabled property is enabled, this method can be used to add an access rule that grants the process specified by ProcessFileName or ProcessId the access right specified by DesiredAccess.

Processes that are already running can be specified by passing their process Id (PID) for the ProcessId parameter (in which case ProcessFileName should be empty). Processes that have not yet started can be specified by passing the full file name of the process's executable file for ProcessFileName (in which case ProcessId should be set to 0). If ProcessName is empty, and ProcessId is -1, the new rule will apply to all processes. When adding a PID-based rule, you need to be aware of the PID Reuse behavior of Windows.

ChildProcesses controls whether the rule also applies to children of the target process.

DesiredAccess specifies the access right to grant; valid values are:

To remove the process access rule later, pass the same ProcessFileName and ProcessId values to the RemoveGrantedProcess method.

Note: This method can be called only when Active is , and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

AddMountingPoint Method (CBVaultDrive Module)

Adds a mounting point for the virtual drive.

Syntax

• Swift
• Objective-C

public func addMountingPoint(mountingPoint: String, flags: Int32, authenticationId: Int64) throws -> Void

- (void)addMountingPoint:(NSString*)mountingPoint :(int)flags :(long long)authenticationId;

Remarks

This method adds a new mounting point for the virtual drive (which must have already been created using OpenVault). Virtual drives may have as many mounting points as desired.

MountingPoint should be set to the name/path of the mounting point. The format of this value varies based what type of mounting point the application wishes to create; please refer to the Mounting Points topic for more information.

The Flags parameter is used to specify properties for the mounting point, and should be set by OR'ing together zero or more of the following flags:

Windows:

Linux and macOS:

For more information about the "-olocal" option of macFUSE, please refer to the macFUSE FAQ.

Windows:

If the STGMP_LOCAL flag is set, the AuthenticationId parameter should be set to the Authentication ID of the user session the mounting point should visible in; or to 0 to make the mounting point visible in the current user session. If the aforementioned flag is not set and AuthenticationId is 0, the mounting point will be global (i.e., visible in all user sessions). When AuthenticationId is set to a non-zero value, STGMP_LOCAL is implied. Please refer to the Mounting Points topic for more information.

Linux, macOS: The AuthenticationId parameter is ignored.

Note: This method cannot be called within events.

The methods and properties related to mounting points are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of mounting points occurs in a thread-safe manner.

Virtual Drives and Mounting Points

When applications call the OpenVault (CBVaultDrive) or CreateVault method, the specified vault is opened and used to create and mount a virtual drive. This virtual drive is created without a drive letter.

To add a drive letter for the virtual drive, applications have to call the AddMountingPoint method. Once a drive letter is assigned, the virtual drive will be visible to the system and other applications, allowing them to start accessing its files and directories.

CacheFilePassword Method (CBVaultDrive Module)

This method caches an encryption password to use the next time a file or alternate stream is accessed or removes the cached password.

Syntax

• Swift
• Objective-C

public func cacheFilePassword(fileName: String, password: String, ttlInCache: Int32, removeFromCache: Bool) throws -> Void

- (void)cacheFilePassword:(NSString*)fileName :(NSString*)password :(int)TTLInCache :(BOOL)removeFromCache;

Remarks

This method temporarily caches an encryption password so that it can be used the next time the file or alternate stream specified by FileName is accessed.

The value passed for FileName must be a vault-local absolute path.

The Password parameter specifies the password to cache. It must match the one last used to encrypt the specified file or the alternate stream; otherwise, this method .

The specified password is automatically removed from the cache as soon as one of the following things occur:

• The password is used to access the file or alternate stream and the value of the TTLInCache parameter is 0.
• The password for the file or alternate stream is changed.
• The vault is closed.
• The timeout expires.

To remove the previously cached password from the cache, set the RemoveFromCache parameter to . When it is set so, the value of the Password parameter is ignored.

The TTLInCache parameter specifies time to seconds that the class keeps the password in the internal cache to reduce the number of requests for a password. The value of 0 tells the class to discard the password after the first use.

As an alternative to using this method, applications can provide a default file encryption password using the DefaultFileAccessPassword property or provide such passwords dynamically using the FilePasswordNeeded event.

Note: This method can be called only when Active is .

CheckAndRepair Method (CBVaultDrive Module)

This method checks a vault's consistency and repairs it as necessary.

Syntax

• Swift
• Objective-C

public func checkAndRepair(flags: Int32) throws -> Void

- (void)checkAndRepair:(int)flags;

Remarks

This method checks the consistency of a vault and attempts to repair it as necessary.

Applications should call this method if a vault has become corrupted (i.e., if the IsCorrupted property is , or if a vault operation fails with a "Vault Corrupted" error). Be sure to make a vault backup before calling this method, because its repair efforts may cause data loss in cases of severe corruption. Please refer to the Vault Corruption topic for more information.

The Flags parameter is used to specify additional options, and it should be set by ORing together zero or more of the following flags:

Note: This method cannot be called when Active is , and it cannot be called within events.

CheckFilePassword Method (CBVaultDrive Module)

This method verifies whether a particular file password is correct.

Syntax

• Swift
• Objective-C

public func checkFilePassword(fileName: String, password: String) throws -> Bool

- (BOOL)checkFilePassword:(NSString*)fileName :(NSString*)password;

Remarks

This method verifies whether the specified Password matches the one used to encrypt the file or alternate stream specified by FileName. If the password is correct, this method returns ; otherwise, it returns .

The value passed for FileName must be a vault-local absolute path.

Please refer to the Encryption topic for more information.

Note: This method can be called only when Active is .

CheckVaultPassword Method (CBVaultDrive Module)

This method verifies whether a particular vault password is correct.

Syntax

• Swift
• Objective-C

public func checkVaultPassword(password: String) throws -> Bool

- (BOOL)checkVaultPassword:(NSString*)password;

Remarks

This method verifies whether the specified Password matches the one used to encrypt the vault. If the password is correct, this method returns ; otherwise, it returns .

Please refer to the Encryption topic for more information.

Note: This method can be called only when Active is .

CloseOpenedFilesSnapshot Method (CBVaultDrive Module)

Closes the previously-created opened files snapshot.

Syntax

• Swift
• Objective-C

public func closeOpenedFilesSnapshot() throws -> Void

- (void)closeOpenedFilesSnapshot;

Remarks

This method closes the opened files snapshot previously created by CreateOpenedFilesSnapshot, releasing the memory associated with it. Please refer to that method's documentation for more information.

Note: This method cannot be called within events.

The methods and properties related to open files snapshots are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that creation, use, and cleanup of open files snapshots occurs in a thread-safe manner.

CloseVault Method (CBVaultDrive Module)

Closes the vault.

Syntax

• Swift
• Objective-C

public func closeVault(force: Bool) throws -> Void

- (void)closeVault:(BOOL)force;

Remarks

This method closes the currently-open vault.

For CBVaultDrive, the Force parameter specifies whether to forcefully close any file or directory handles open currently. If Force is , this method will fail if any handles are currently open.

Note: This method can be called only when Active is .

CompactVault Method (CBVaultDrive Module)

This method compacts the vault.

Syntax

• Swift
• Objective-C

public func compactVault() throws -> Bool

- (BOOL)compactVault;

Remarks

This method triggers vault compaction, which is a process that shrinks a vault's overall size by truncating its free space. If the compacting operation completes successfully, this method returns ; otherwise, it returns .

Compaction involves physically moving a vault's occupied pages to the beginning of the vault, and then truncating the unoccupied pages from the end of the vault. The runtime of a compacting operation depends on a number of factors, and it is possible for it to be interrupted by other vault operations.

Compaction occurs automatically when the vault's free space percentage exceeds the threshold specified by the AutoCompactAt property. Applications can also use the AutoCompactDelay configuration setting to add a delay to the automatic compaction trigger.

Note: A vault opened in ReadOnly mode cannot be compacted, either automatically or explicitly.

Note: This method can be called only when Active is , and it cannot be called within events.

Config Method (CBVaultDrive Module)

This method sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

ConvertToDrivePath Method (CBVaultDrive Module)

Converts a vault-local vault item path to a virtual drive file path (Windows only).

Syntax

• Swift
• Objective-C

public func convertToDrivePath(vaultFilePath: String) throws -> String

- (NSString*)convertToDrivePath:(NSString*)vaultFilePath;

Remarks

This method returns a virtual drive file path that corresponds to the vault item (file, directory, or symbolic link) specified by VaultFilePath.

The value passed for VaultFilePath must be a vault-local absolute path.

The value returned by this method is a fully-qualified file path formatted according to OS conventions, suitable for passing to system file APIs and/or external applications.

Note: This method can be called only when Active is .

ConvertToVaultPath Method (CBVaultDrive Module)

Converts a virtual drive file path to a vault-local vault item path (Windows only).

Syntax

• Swift
• Objective-C

public func convertToVaultPath(virtualFilePath: String) throws -> String

- (NSString*)convertToVaultPath:(NSString*)virtualFilePath;

Remarks

This method returns the vault-local absolute path of the vault item (file, directory, or symbolic link) that corresponds to the virtual drive file path specified by VirtualFilePath.

The value passed for VirtualFilePath must be a fully-qualified file path formatted according to OS conventions.

The value returned by this method can be used to access the corresponding vault item using the class APIs.

Note: This method can be called only when Active is .

CreateDirectory Method (CBVaultDrive Module)

This method creates a new directory in the vault.

Syntax

• Swift
• Objective-C

public func createDirectory(directory: String, createParents: Bool) throws -> Void

- (void)createDirectory:(NSString*)directory :(BOOL)createParents;

Remarks

This method creates a new directory in the vault at the path specified by Directory.

The value passed for Directory must be a vault-local absolute path.

The CreateParents parameter specifies whether nonexistent parent directories in the specified path should be created as well. If this parameter is , and one or more parent directories are missing, this method .

Note: This method can be called only when Active is , and it cannot be called within events.

CreateLink Method (CBVaultDrive Module)

This method creates a symbolic link to another file in the vault.

Syntax

• Swift
• Objective-C

public func createLink(linkName: String, destinationName: String) throws -> Void

- (void)createLink:(NSString*)linkName :(NSString*)destinationName;

Remarks

This method creates a new symbolic link named LinkName that points to the file specified by DestinationName.

The value passed for LinkName must be a vault-local absolute path. The value passed for DestinationName must also be a vault-local path, but it may be absolute or relative to LinkName.

Note: This method can be called only when Active is , and it cannot be called within events.

CreateOpenedFilesSnapshot Method (CBVaultDrive Module)

Creates a snapshot of information about files that are currently open.

Syntax

• Swift
• Objective-C

public func createOpenedFilesSnapshot() throws -> Void

- (void)createOpenedFilesSnapshot;

Remarks

This method creates a snapshot of information about all files and directories in the virtual filesystem that are currently open. This information is then used to populate the OpenFile* properties.

Note that there will always be at least one item in the OpenFile* properties since the virtual volume itself is always inherently open.

When the application is finished working with the opened files snapshot, it must close it by calling the CloseOpenedFilesSnapshot method in order to release the associated memory. If this method is called again before an existing snapshot is closed, the class will attempt to close it before creating a new one.

Note: This method can be called only when Active is , and it cannot be called within events.

The methods and properties related to open files snapshots are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that creation, use, and cleanup of open files snapshots occurs in a thread-safe manner.

DeleteFile Method (CBVaultDrive Module)

This method deletes a vault item.

Syntax

• Swift
• Objective-C

public func deleteFile(fileName: String) throws -> Void

- (void)deleteFile:(NSString*)fileName;

Remarks

This method deletes the vault item (file, directory, symbolic link, or alternate stream) specified by FileName from the vault.

The value passed for FileName must be a vault-local absolute path.

Please note the following:

• When a file is deleted, any alternate streams it contains are deleted as well.
• Directories must be empty to be deleted; otherwise, this method . Use the IsDirectoryEmpty method to check whether a directory is empty.
• Deleting a symbolic link only deletes the link itself, not the file it points to.

Note: This method can be called only when Active is , and it cannot be called within events.

DeleteFileTag Method (CBVaultDrive Module)

This method deletes a file tag.

Syntax

• Swift
• Objective-C

public func deleteFileTag(fileName: String, tagId: Int32, tagName: String) throws -> Void

- (void)deleteFileTag:(NSString*)fileName :(int)tagId :(NSString*)tagName;

Remarks

This method deletes the file tag identified by TagId or TagName from the file, directory, or alternate stream specified by FileName.

The value passed for FileName must be a vault-local absolute path.

To delete a raw file tag, pass its Id for TagId and pass an empty string for TagName. To delete a typed file tag, pass its name for TagName and pass 0 for TagId. If values are provided for both TagId and TagName, this method .

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is , and it cannot be called within events.

EjectVolume Method (CBVaultDrive Module)

Ejects a removable storage volume formatted with the CBFS Storage filesystem (Windows only).

Syntax

• Swift
• Objective-C

public func ejectVolume(force: Bool) throws -> Void

- (void)ejectVolume:(BOOL)force;

Remarks

If the currently-open vault resides on a removable storage volume formatted with the CBFS Storage filesystem (i.e., if the vault was opened using the OpenVolume method), this method can be used to eject it. If this method is successful, the vault is closed, and the volume is made available for removal (similar to how the "Eject" functionality provided by Windows File Explorer works).

The Force parameter specifies whether the removable storage volume should be forcefully ejected. If Force is , this method will fail if the vault is currently in use by the system or other applications.

Note: This method can be called only when Active is , and it cannot be called within events.

FileExists Method (CBVaultDrive Module)

This method checks whether a vault item exists.

Syntax

• Swift
• Objective-C

public func fileExists(fileName: String) throws -> Bool

- (BOOL)fileExists:(NSString*)fileName;

Remarks

This method checks whether a vault item (file, directory, symbolic link, or alternate stream) with the specified FileName exists in the vault. If the specified vault item exists, this method returns ; otherwise, it returns .

The value passed for FileName must be a vault-local absolute path.

Note: This method can be called only when Active is .

FileMatchesMask Method (CBVaultDrive Module)

This method checks whether a particular file or directory name matches the specified mask.

Syntax

• Swift
• Objective-C

public func fileMatchesMask(mask: String, fileName: String, caseSensitive: Bool) throws -> Bool

- (BOOL)fileMatchesMask:(NSString*)mask :(NSString*)fileName :(BOOL)caseSensitive;

Remarks

This method checks whether the file or directory name specified by FileName matches Mask; if it does, this method returns . The CaseSensitive parameter controls whether a case-sensitive match should be performed.

Note: This method does not handle so-called DOS_* wildcards (DOS_STAR, DOS_QM, DOS_DOT). The explanation about the characters can be found in the MSDN article. If you have a mask that includes one of those characters on Windows, you can use the RtlIsNameInExpression function of Windows API.

Note: As the explanation states, "When you do a case-insensitive search and do not provide a translation table, the name is converted to uppercase."

FileTagExists Method (CBVaultDrive Module)

This method checks whether a file tag exists.

Syntax

• Swift
• Objective-C

public func fileTagExists(fileName: String, tagId: Int32, tagName: String) throws -> Bool

- (BOOL)fileTagExists:(NSString*)fileName :(int)tagId :(NSString*)tagName;

Remarks

This method checks whether a file tag with the specified TagId or TagName is attached to the file, directory, or alternate stream specified by FileName. If the specified file tag exists, this method returns ; otherwise, it returns .

The value passed for FileName must be a vault-local absolute path.

To check for a raw file tag, pass its Id for TagId and pass an empty string for TagName. To check for a typed file tag, pass its name for TagName and pass 0 for TagId. If values are provided for both TagId and TagName, this method .

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

FileTimeToNanoseconds Method (CBVaultDrive Module)

This method returns the subsecond part of the time expressed in nanoseconds.

Syntax

• Swift
• Objective-C

public func fileTimeToNanoseconds(fileTime: Date) throws -> Int32

- (int)fileTimeToNanoseconds:(NSDate*)fileTime;

Remarks

Use this method to obtain the subsecond part of the FileTime value, expressed in nanoseconds.

FileTimeToUnixTime Method (CBVaultDrive Module)

This method converts FileTime to Unix time format.

Syntax

• Swift
• Objective-C

public func fileTimeToUnixTime(fileTime: Date) throws -> Int64

- (long long)fileTimeToUnixTime:(NSDate*)fileTime;

Remarks

Use this method to convert the FileTime value to Unix time format. The subsecond part of the value is not preserved; to obtain it, use the FileTimeToNanoseconds method.

FindClose Method (CBVaultDrive Module)

This method closes a search operation and releases any associated resources.

Syntax

• Swift
• Objective-C

public func findClose(searchId: Int64) throws -> Void

- (void)findClose:(long long)searchId;

Remarks

This method closes the search operation identified by SearchId, releasing any previously allocated resources associated with it.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

Note: This method can be called only when Active is .

FindFirst Method (CBVaultDrive Module)

This method searches for the first vault item that matches the specified name and attributes.

Syntax

• Swift
• Objective-C

public func findFirst(fileMask: String, attributes: Int32, flags: Int32) throws -> Int64

- (long long)findFirst:(NSString*)fileMask :(int)attributes :(int)flags;

Remarks

This method initiates a search operation based on the specified FileMask, Attributes, and Flags. If there are any matching vault items (files, directories, symbolic links, or alternate streams), then a search operation Id is returned. If there are no matching vault items, then -1 is returned.

To obtain information about a search result, pass the returned search handle to the following methods:

• GetSearchResultAttributes
• GetSearchResultCreationTime
• GetSearchResultFullName
• GetSearchResultLastAccessTime
• GetSearchResultLinkDestination
• GetSearchResultMetadataSize
• GetSearchResultModificationTime
• GetSearchResultName
• GetSearchResultSize

To retrieve the next search result, pass the returned search handle to the FindNext method. When an application is finished with (or wants to abandon) a search operation, it must pass the associated search handle to the FindClose method to release the resources associated with it.

Because each search operation is identified by the search handle associated with it, applications may initiate additional search operations at any time and may process each operation's search results in any manner it desires (e.g., sequentially, round robin).

The FileMask parameter specifies both the directory path to search within and the file name mask to match against (e.g., \directory\to\search\*.txt). Or, when searching a file's alternate streams, it specifies the file path and stream name mask (e.g., \path\to\file:*). Only the mask may contain wildcards. The path must be specified in vault-local absolute format. Also note that files without an extension will match *, but not *.*.

The Attributes parameter specifies the attributes to match against; items will match only if they have one or more of the specified attributes. The value passed for this parameter should be constructed by ORing together zero or more of the following values. Passing 0 will allow any file in a directory (or, any alternate stream in a file) to match; it is equivalent to VAULT_FATTR_FILE | VAULT_FATTR_DATA_STREAM.

The Flags parameter controls search behavior. Among other things, it can be used to request that only specific pieces of information be returned, which can greatly improve performance. The value passed for this parameter should be constructed by ORing together zero or more of the following values:

Note: This method can be called only when Active is , and it cannot be called within events.

FindFirstByQuery Method (CBVaultDrive Module)

This method searches for the first file or directory whose file tags match the specified query.

Syntax

• Swift
• Objective-C

public func findFirstByQuery(directory: String, query: String, flags: Int32) throws -> Int64

- (long long)findFirstByQuery:(NSString*)directory :(NSString*)query :(int)flags;

Remarks

This method initiates a search operation within the specified Directory for files and subdirectories whose typed file tags match the specified Query. If there are any matching files or directories, then a search operation Id is returned. If there are no matching files or directories, then -1 is returned.

To obtain information about a search result, pass the returned search handle to the following methods:

• GetSearchResultAttributes
• GetSearchResultCreationTime
• GetSearchResultFullName
• GetSearchResultLastAccessTime
• GetSearchResultLinkDestination
• GetSearchResultMetadataSize
• GetSearchResultModificationTime
• GetSearchResultName
• GetSearchResultSize

To retrieve the next search result, pass the returned search handle to the FindNext method. When an application is finished with (or wants to abandon) a search operation, it must pass the associated search handle to the FindClose method to release the resources associated with it.

Because each search operation is identified by the search handle associated with it, applications may initiate additional search operations at any time and may process each operation's search results in any manner it desires (e.g., sequentially, round robin).

The value passed for Directory must be a vault-local absolute path.

The value passed for Query must be a search query constructed using the CBFS Storage Query Language; please refer to that topic for more information.

The Flags parameter controls search behavior. Among other things, it can be used to request that only specific pieces of information be returned, which can greatly improve performance. The value passed for this parameter should be constructed by ORing together zero or more of the following values:

Note: This method can be called only when Active is , and it cannot be called within events.

FindNext Method (CBVaultDrive Module)

This method searches for the next vault item that matches an ongoing search operation.

Syntax

• Swift
• Objective-C

public func findNext(searchId: Int64) throws -> Bool

- (BOOL)findNext:(long long)searchId;

Remarks

This method searches for the next vault item (file, directory, symbolic link, or alternate stream) that matches the ongoing search operation identified by SearchId. If a matching vault item is found, this method returns ; otherwise, it returns .

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery. Please refer to the methods' documentation for more information about search operations.

Note: This method can be called only when Active is , and it cannot be called within events.

ForceUnmount Method (CBVaultDrive Module)

Forcefully unmounts the virtual drive associated with the specified vault (Windows only).

Syntax

• Swift
• Objective-C

public func forceUnmount(vaultFile: String) throws -> Void

- (void)forceUnmount:(NSString*)vaultFile;

Remarks

This method instructs the CBFS Storage driver to forcefully unmount the virtual drive associated with the vault storage file specified by VaultFile. Typically, this is only necessary if an application crashes without first unmounting the virtual drive(s) that it created.

Please note that only the processes which have access to a vault storage file may forcefully unmount a virtual drive associated with it.

The value passed for VaultFile must be a fully-qualified file path formatted according to OS conventions.

Note: This method cannot be called within events.

FormatVolume Method (CBVaultDrive Module)

Formats a storage volume or partition with the CBFS Storage filesystem (Windows only).

Syntax

• Swift
• Objective-C

public func formatVolume(volumeName: String, flags: Int32) throws -> Void

- (void)formatVolume:(NSString*)volumeName :(int)flags;

Remarks

This method formats the storage volume or partition specified by VolumeName with the CBFS Storage filesystem, allowing it to be opened as a vault using the OpenVolume method.

The VolumeName parameter specifies the fully-qualified name of a storage volume or partition. DOS names, such as X:, are also valid.

The Flags parameter is used to control formatting options, and should be set by OR'ing together zero or more of the following flags:

Note that formatting a large storage partition or volume can take a significant amount of time, and this method will block until the formatting process is complete.

Note: This method cannot be called when Active is , and it cannot be called within events.

GetDriverStatus Method (CBVaultDrive Module)

Retrieves the status of the system driver.

Syntax

• Swift
• Objective-C

public func getDriverStatus(productGUID: String, module: Int32) throws -> Int32

- (int)getDriverStatus:(NSString*)productGUID :(int)module;

Remarks

This method retrieves the status of the system driver module specified by Module. This status can then be used to verify whether it has been properly installed and is ready for use.

The value returned by the method corresponds to the dwCurrentState field of the SERVICE_STATUS structure from the Windows API. It will be one of the following:

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• Install
• Uninstall
• GetDriverStatus
• GetModuleVersion
• RegisterIcon
• UnregisterIcon
• Initialize

The Module parameter specifies which driver module to query the status of. Possible values are:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation in Windows topic for more information about the latter.

Note: This method cannot be called within events.

GetFileAttributes Method (CBVaultDrive Module)

This method retrieves the attributes of a vault item.

Syntax

• Swift
• Objective-C

public func getFileAttributes(fileName: String) throws -> Int32

- (int)getFileAttributes:(NSString*)fileName;

Remarks

This method retrieves the attributes of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The specified vault item's attributes are returned as a 32-bit integer composed of one or more of the following values:

Note: This method can be called only when Active is .

GetFileCompression Method (CBVaultDrive Module)

This method retrieves the compression mode of a file or alternate stream.

Syntax

• Swift
• Objective-C

public func getFileCompression(fileName: String) throws -> Int32

- (int)getFileCompression:(NSString*)fileName;

Remarks

This method retrieves the compression mode of the file or alternate stream specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The returned compression mode will be one of the following values:

Applications that use custom compression must implement the DataCompress and DataDecompress events. Please refer to the Compression topic for more information.

Note: This method can be called only when Active is .

GetFileCreationTime Method (CBVaultDrive Module)

This method retrieves the creation time of a vault item.

Syntax

• Swift
• Objective-C

public func getFileCreationTime(fileName: String) throws -> Date

- (NSDate*)getFileCreationTime:(NSString*)fileName;

Remarks

This method retrieves the creation time of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName. The timestamps returned by this method are specified .

The value passed for FileName must be a vault-local absolute path.

Note: This method can be called only when Active is .

GetFileEncryption Method (CBVaultDrive Module)

This method retrieves the encryption mode of a file or alternate stream.

Syntax

• Swift
• Objective-C

public func getFileEncryption(fileName: String) throws -> Int32

- (int)getFileEncryption:(NSString*)fileName;

Remarks

This method retrieves the encryption mode of the file or alternate stream specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The returned encryption mode will be one of the following values:

Applications that use custom encryption must implement at least the DataEncrypt and DataDecrypt events. Certain custom encryption modes may require that the HashCalculate or KeyDerive event be implemented as well. Please refer to the Encryption topic for more information.

Note: This method can be called only when Active is .

GetFileLastAccessTime Method (CBVaultDrive Module)

This method retrieves the last access time of a vault item.

Syntax

• Swift
• Objective-C

public func getFileLastAccessTime(fileName: String) throws -> Date

- (NSDate*)getFileLastAccessTime:(NSString*)fileName;

Remarks

This method retrieves the creation time of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName. The timestamps returned by this method are specified .

Note: Vault items' last access times are updated only if the UseAccessTime property is enabled.

The value passed for FileName must be a vault-local absolute path.

Note: This method can be called only when Active is .

GetFileModificationTime Method (CBVaultDrive Module)

This method retrieves the modification time of a vault item.

Syntax

• Swift
• Objective-C

public func getFileModificationTime(fileName: String) throws -> Date

- (NSDate*)getFileModificationTime:(NSString*)fileName;

Remarks

This method retrieves the modification time of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName. The timestamps returned by this method are specified .

The value passed for FileName must be a vault-local absolute path.

Note: This method can be called only when Active is .

GetFileSize Method (CBVaultDrive Module)

This method retrieves the size of a file or alternate stream.

Syntax

• Swift
• Objective-C

public func getFileSize(fileName: String) throws -> Int64

- (long long)getFileSize:(NSString*)fileName;

Remarks

This method retrieves the size, in bytes, of the file or alternate stream specified by FileName.

Note: For files, the returned value reflects only the size of the file's immediate contents, it does not account for any alternate streams the file may or may not contain.

The value passed for FileName must be a vault-local absolute path.

Note: This method can be called only when Active is .

GetFileTag Method (CBVaultDrive Module)

This method retrieves the binary data held by a raw file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTag(fileName: String, tagId: Int32) throws -> Data

- (NSData*)getFileTag:(NSString*)fileName :(int)tagId;

Remarks

This method retrieves the binary data held by a raw file tag, identified by TagId, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a raw file tag with the specified TagId is not attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagId must be in the range 0x0001 to 0xCFFF (inclusive).

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

GetFileTagAsAnsiString Method (CBVaultDrive Module)

This method retrieves the value of an AnsiString-typed file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTagAsAnsiString(fileName: String, tagName: String) throws -> String

- (NSString*)getFileTagAsAnsiString:(NSString*)fileName :(NSString*)tagName;

Remarks

This method retrieves the value of an AnsiString-typed file tag, identified by TagName, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If an AnsiString-typed file tag with the specified TagName is not attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

Please refer to the File Tags topic for more information.

This method can only retrieve typed file tags created with the SetFileTagAsAnsiString method. Typed file tags created with the SetFileTagAsString method must be retrieved using the GetFileTagAsString method.

Note: This method can be called only when Active is .

GetFileTagAsBoolean Method (CBVaultDrive Module)

This method retrieves the value of a Boolean-typed file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTagAsBoolean(fileName: String, tagName: String) throws -> Bool

- (BOOL)getFileTagAsBoolean:(NSString*)fileName :(NSString*)tagName;

Remarks

This method retrieves the value of a Boolean-typed file tag, identified by TagName, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a Boolean-typed file tag with the specified TagName is not attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

GetFileTagAsDateTime Method (CBVaultDrive Module)

This method retrieves the value of a DateTime-typed file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTagAsDateTime(fileName: String, tagName: String) throws -> Date

- (NSDate*)getFileTagAsDateTime:(NSString*)fileName :(NSString*)tagName;

Remarks

This method retrieves the value of a DateTime-typed file tag, identified by TagName, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a DateTime-typed file tag with the specified TagName is not attached to the specified vault item, this method .

The timestamps returned by this method are specified .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

GetFileTagAsNumber Method (CBVaultDrive Module)

This method retrieves the value of a Number-typed file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTagAsNumber(fileName: String, tagName: String) throws -> Int64

- (long long)getFileTagAsNumber:(NSString*)fileName :(NSString*)tagName;

Remarks

This method retrieves the value of a Number-typed file tag, identified by TagName, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a Number-typed file tag with the specified TagName is not attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

GetFileTagAsString Method (CBVaultDrive Module)

This method retrieves the value of a String-typed file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTagAsString(fileName: String, tagName: String) throws -> String

- (NSString*)getFileTagAsString:(NSString*)fileName :(NSString*)tagName;

Remarks

This method retrieves the value of a String-typed file tag, identified by TagName, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a String-typed file tag with the specified TagName is not attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

Please refer to the File Tags topic for more information.

This method can only retrieve typed file tags created with the SetFileTagAsString method. Typed file tags created with the SetFileTagAsAnsiString method must be retrieved using the GetFileTagAsAnsiString method.

Note: This method can be called only when Active is .

GetFileTagDataType Method (CBVaultDrive Module)

This method retrieves the data type of a typed file tag attached to a specific vault item.

Syntax

• Swift
• Objective-C

public func getFileTagDataType(fileName: String, tagName: String) throws -> Int32

- (int)getFileTagDataType:(NSString*)fileName :(NSString*)tagName;

Remarks

This method retrieves the data type of a typed file tag, identified by TagName, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a typed file tag with the specified TagName is not attached to the specified vault item, this method .

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

The value returned by this method will be one of the following (except VAULT_TDT_RAWDATA, which is not applicable):

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

GetFileTagSize Method (CBVaultDrive Module)

This method retrieves the size of a raw file tag attached to the specified vault item.

Syntax

• Swift
• Objective-C

public func getFileTagSize(fileName: String, tagId: Int32) throws -> Int32

- (int)getFileTagSize:(NSString*)fileName :(int)tagId;

Remarks

This method retrieves the size of the binary data held by a raw file tag, identified by TagId, attached to the vault item (e.g., file, directory, or alternate stream) specified by FileName. If a raw file tag with the specified TagId is not attached to the specified vault item, this method returns 0 as the tag size.

The value passed for FileName must be a vault-local absolute path. The value passed for TagId must be in the range 0x0001 to 0xCFFF (inclusive).

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is .

GetModuleVersion Method (CBVaultDrive Module)

Retrieves the version of a given product module.

Syntax

• Swift
• Objective-C

public func getModuleVersion(productGUID: String, module: Int32) throws -> Int64

- (long long)getModuleVersion:(NSString*)productGUID :(int)module;

Remarks

This method retrieves the version of the product module specified by Module. The value is returned as a 64-bit integer composed of four 16-bit words that each correspond to a piece of the overall module version. For example, a version of 2.32.6.28 would cause the value 0x000200200006001C to be returned.

If the specified module is not installed, this method returns 0.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• Install
• Uninstall
• GetDriverStatus
• GetModuleVersion
• RegisterIcon
• UnregisterIcon
• Initialize

The Module parameter specifies which driver module to query the status of. Possible values are:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation in Windows topic for more information about the latter.

Note: This method cannot be called within events.

GetOriginatorProcessId Method (CBVaultDrive Module)

Retrieves the Id of the process (PID) that initiated the operation.

Syntax

• Swift
• Objective-C

public func getOriginatorProcessId() throws -> Int32

- (int)getOriginatorProcessId;

Remarks

This method can be called within the FilePasswordNeeded and FileAccess events to retrieve the Id of the process (PID) that initiated the operation. If the query fails, this method returns 0.

Please note that PIDs are not unique, and may be reused by different processes over time (though in practice, this is uncommon).

CBVaultDrive/Windows-specific: Applications cannot use this method to retrieve information about remote processes accessing virtual drives shared on the network. Windows does not provide such information due to the nature of remote access.

GetOriginatorProcessName Method (CBVaultDrive Module)

Retrieves the name of the process that initiated the operation.

Syntax

• Swift
• Objective-C

public func getOriginatorProcessName() throws -> String

- (NSString*)getOriginatorProcessName;

Remarks

This method can be called within the FilePasswordNeeded and and FileAccess events to retrieve the name of the process that initiated the operation. If the query fails, this method returns empty string.

CBVaultDrive/Windows-specific: Applications cannot use this method to retrieve information about remote processes accessing virtual drives shared on the network. Windows does not provide such information due to the nature of remote access.

GetOriginatorThreadId Method (CBVaultDrive Module)

Retrieves the Id of the thread that initiated the operation (Windows only).

Syntax

• Swift
• Objective-C

public func getOriginatorThreadId() throws -> Int32

- (int)getOriginatorThreadId;

Remarks

This method can be called within the FilePasswordNeeded and FileAccess events to retrieve the Id of the thread that initiated the operation. If the query fails, this method returns 0.

Please note that thread Ids are not unique, and may be reused by different threads over time.

GetOriginatorToken Method (CBVaultDrive Module)

Retrieves the security token associated with the process that initiated the operation (Windows only).

Syntax

• Swift
• Objective-C

public func getOriginatorToken() throws -> Int64

- (long long)getOriginatorToken;

Remarks

This method can be called within the FilePasswordNeeded event to retrieve the security token associated with the process that initiated the operation. If the query fails, this method returns INVALID_HANDLE_VALUE.

The security token returned by this method can be passed to the Windows API's GetTokenInformation function to obtain more information about the process.

Important: When applications are finished using the returned security token, they must close it using the Windows API's CloseHandle function.

Network Access Notes (CBVaultDrive-specific)

For virtual drives shared on the network, applications may wish to obtain information about the network users accessing it (e.g., account names). Drives can be shared in several modes in Windows, which can affect the information retrievable via the security token this method returns:

• Authenticated mode, in which case the Helper DLL (which, in general, is responsible for relaying remote drive requests to and from the system driver) will impersonate the network user, allowing that account's actual information to be retrieved.
• Guest mode, in which case the retrievable information is for the system's GUEST account.
• Administrative shares (those which exist by default and whose names end with '$'; e.g., C$, ADMIN$, etc.), in which case the retrievable information is for the LOCAL_SYSTEM account.

GetSearchResultAttributes Method (CBVaultDrive Module)

This method retrieves the attributes of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultAttributes(searchId: Int64) throws -> Int32

- (int)getSearchResultAttributes:(long long)searchId;

Remarks

This method retrieves the attributes of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

The vault item's attributes are returned as a 32-bit integer composed of one or more of the following values:

If, however, attributes were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_ATTRIBUTES for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return 0. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultCreationTime Method (CBVaultDrive Module)

This method retrieves the creation time of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultCreationTime(searchId: Int64) throws -> Date

- (NSDate*)getSearchResultCreationTime:(long long)searchId;

Remarks

This method retrieves the creation time of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

The timestamps returned by this method are specified .

If times were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_TIMES for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return January 1, 1601 00:00:00 UTC. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultFullName Method (CBVaultDrive Module)

This method retrieves the fully qualified name of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultFullName(searchId: Int64) throws -> String

- (NSString*)getSearchResultFullName:(long long)searchId;

Remarks

This method retrieves the fully qualified name of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId (i.e., the vault item's vault-local absolute path). Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

If fully qualified names were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_FULL_NAME for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return an empty string. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultLastAccessTime Method (CBVaultDrive Module)

This method retrieves the last access time of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultLastAccessTime(searchId: Int64) throws -> Date

- (NSDate*)getSearchResultLastAccessTime:(long long)searchId;

Remarks

This method retrieves the creation time of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

The timestamps returned by this method are specified .

If times were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_TIMES for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return January 1, 1601 00:00:00 UTC. Please refer to the documentation for these methods for more information.

Note: Vault items' last access times are updated only if the UseAccessTime property is enabled.

Note: This method can be called only when Active is .

GetSearchResultLinkDestination Method (CBVaultDrive Module)

This method retrieves the destination of a symbolic link found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultLinkDestination(searchId: Int64) throws -> String

- (NSString*)getSearchResultLinkDestination:(long long)searchId;

Remarks

This method retrieves the fully qualified name of a symbolic link found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

If the most recently found vault item is not a symbolic link, or if symbolic link destinations were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_LINK_DEST for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return an empty string. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultMetadataSize Method (CBVaultDrive Module)

This method retrieves the size of the metadata associated with a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultMetadataSize(searchId: Int64) throws -> Int64

- (long long)getSearchResultMetadataSize:(long long)searchId;

Remarks

This method retrieves the size of the metadata associated with a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The metadata size of a vault item reflects the total size of all vault pages associated with it that do not contain actual file/stream data; this includes file tags (both internal and application defined), index pages, B-trees, and all other "filesystem information".

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

If metadata sizes were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_METADATA_SIZE for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return 0. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultModificationTime Method (CBVaultDrive Module)

This method retrieves the modification time of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultModificationTime(searchId: Int64) throws -> Date

- (NSDate*)getSearchResultModificationTime:(long long)searchId;

Remarks

This method retrieves the modification time of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

The timestamps returned by this method are specified .

If times were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_TIMES for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return January 1, 1601 00:00:00 UTC. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultName Method (CBVaultDrive Module)

This method retrieves the name of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultName(searchId: Int64) throws -> String

- (NSString*)getSearchResultName:(long long)searchId;

Remarks

This method retrieves the name of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

The names returned by this method do not include a path; use GetSearchResultFullName if a path is needed.

If names were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_NAME for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return an empty string. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

GetSearchResultSize Method (CBVaultDrive Module)

This method retrieves the size of a vault item found during a search operation.

Syntax

• Swift
• Objective-C

public func getSearchResultSize(searchId: Int64) throws -> Int64

- (long long)getSearchResultSize:(long long)searchId;

Remarks

This method retrieves the size of a vault item (e.g., file, directory, symbolic link, or alternate stream) found via FindFirst/FindFirstByQuery/FindNext as part of the search operation identified by SearchId. Please refer to those methods' documentation for more information.

Note: For files, the returned value reflects only the size of the file's immediate contents; it does not account for any alternate streams the file may or may not contain.

The value passed for SearchId must be a search operation Id returned by FindFirst or FindFirstByQuery.

If the vault item is a directory, or if sizes were not requested as part of the specified search operation (by passing either 0 or a value including VAULT_FF_NEED_SIZE for the FindFirst/FindFirstByQuery method's Flags parameter), this method will always return 0. Please refer to the documentation for these methods for more information.

Note: This method can be called only when Active is .

Initialize Method (CBVaultDrive Module)

This method initializes the component.

Syntax

• Swift
• Objective-C

public func initialize(productGUID: String) throws -> Void

- (void)initialize:(NSString*)productGUID;

Remarks

This method initializes the class and must be called each time the application starts before attempting to call any of the class's other methods with the exception of installation-related methods.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• Install
• Uninstall
• GetDriverStatus
• GetModuleVersion
• RegisterIcon
• UnregisterIcon
• Initialize

If the required driver was not installed using the Install method with the same value of ProductGUID, Initialize will return a ERROR_FILE_NOT_FOUND error (Win32 error code 2).

If the loaded kernel-mode driver is older than the user-mode API, Initialize will return a ERROR_INVALID_KERNEL_INFO_VERSION error (Win32 error code 340). In this situation, an update of the driver using the Install method is required before the class can be used.

Install Method (CBVaultDrive Module)

Installs (or upgrades) the product's system drivers and/or the helper DLL (Windows only).

Syntax

• Swift
• Objective-C

public func install(cabFileName: String, productGUID: String, pathToInstall: String, modulesToInstall: Int32, flags: Int32) throws -> Int32

- (int)install:(NSString*)cabFileName :(NSString*)productGUID :(NSString*)pathToInstall :(int)modulesToInstall :(int)flags;

Remarks

This method is used to install or upgrade the product's various modules (i.e., the system drivers and the Helper DLL). The ModulesToInstall parameter selects which modules should be installed. If the system must be rebooted to complete the installation process, this method will return a non-zero value indicating which module(s) requested the reboot (out of those initially selected).

Important: To upgrade the product's modules, use only the Install method. Previously installed versions of the modules should not be uninstalled first. Calling the Install method will upgrade the previously installed version.

Please refer to the Driver Installation in Windows topic for more information.

CabFileName must be the path of the .cab file containing the product modules. Important: This .cab file must remain on the target system (or be available in some other way) after installation, as it is required for uninstalling the modules from the system.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• Install
• Uninstall
• GetDriverStatus
• GetModuleVersion
• RegisterIcon
• UnregisterIcon
• Initialize

PathToInstall controls where the modules are installed. Pass empty string (highly recommended) to automatically install them to the appropriate Windows system directory.

ModulesToInstall should contain one or more of the following flags, OR'd together:

Flags specifies various installation options, and should contain zero or more of the following flags, OR'd together:

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation in Windows topic for more information about the latter.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD () error.

Note: This method cannot be called within events.

IsDirectoryEmpty Method (CBVaultDrive Module)

This method checks whether a directory is empty.

Syntax

• Swift
• Objective-C

public func isDirectoryEmpty(directory: String) throws -> Bool

- (BOOL)isDirectoryEmpty:(NSString*)directory;

Remarks

This method checks whether the directory specified by Directory is empty (i.e., does not contain any files, subdirectories, or symbolic links). If the specified directory is empty, this method returns ; otherwise, it returns .

The value passed for Directory must be a vault-local absolute path.

Note: This method can be called only when Active is .

IsIconRegistered Method (CBVaultDrive Module)

Checks whether the specified icon is registered (Windows only).

Syntax

• Swift
• Objective-C

public func isIconRegistered(iconId: String) throws -> Bool

- (BOOL)isIconRegistered:(NSString*)iconId;

Remarks

This method checks whether an icon with the specified IconId has been registered. If such an icon has been registered, this method returns ; otherwise it returns .

Icons can be registered using the RegisterIcon method. Please refer to that method's documentation, as well as the Custom Drive Icons topic, for more information.

The Helper DLL must be installed in order for this method to function correctly. Applications can check to see whether the Helper DLL is installed using the GetModuleVersion method, and install it using the Install method if necessary.

IsValidVault Method (CBVaultDrive Module)

This method checks whether a local file is a CBFS Storage vault.

Syntax

• Swift
• Objective-C

public func isValidVault() throws -> Bool

- (BOOL)isValidVault;

Remarks

This method checks whether the file specified by the VaultFile property is a CBFS Storage vault that can be opened by the class. The file being checked must be fully closed when this method is called.

If the specified file is a CBFS Storage vault, this method returns ; otherwise, it returns .

If the CallbackMode property is enabled, the check will be performed by the appropriate Vault* events (and the value held by VaultFile is simply passed to such events for the application to use).

Note: This method uses a simple detection mechanism; it does not perform a full consistency check or attempt any repairs, so applications may still need to call CheckAndRepair even if this method returns . If an error occurs during the detection process, this method .

Note: This method cannot be called when Active is , and it cannot be called within events.

IsValidVaultVolume Method (CBVaultDrive Module)

Checks whether a storage partition or volume is formatted with the CBFS Storage filesystem (Windows only).

Syntax

• Swift
• Objective-C

public func isValidVaultVolume(volumeName: String) throws -> Bool

- (BOOL)isValidVaultVolume:(NSString*)volumeName;

Remarks

This method checks whether the storage partition or volume specified by VolumeName is formatted with the CBFS Storage filesystem. If the specified storage volume or partition is formatted with the CBFS Storage filesystem, this method returns ; otherwise it returns .

A storage volume or partition formatted with the CBFS Storage filesystem can be opened as a vault using the OpenVolume method.

The VolumeName parameter specifies the fully-qualified name of a storage volume or partition. DOS names, such as X:, are also valid.

Note that this method uses a simple detection mechanism; it doesn't perform a full consistency check or attempt any repairs, so applications may still need to call CheckAndRepair even if this method returns . If an error occurs during the detection process, this method .

Note: This method cannot be called within events.

MoveFile Method (CBVaultDrive Module)

This method renames or moves a vault item.

Syntax

• Swift
• Objective-C

public func moveFile(oldFileName: String, newFileName: String, overwrite: Bool) throws -> Void

- (void)moveFile:(NSString*)oldFileName :(NSString*)newFileName :(BOOL)overwrite;

Remarks

This method renames or moves a vault item (e.g., file, directory, symbolic link, or alternate stream) from the specified OldFileName to the specified NewFileName. For alternate streams, renaming is always possible, but moving them from one file to another is allowed only if the AllowMoveStreamsBetweenFiles configuration setting is enabled.

The values passed for OldFileName and NewFileName must both be vault-local absolute paths (including the item's old and new names, respectively) in the same vault.

The Overwrite parameter specifies what to do if a vault item with the specified NewFileName already exists. If Overwrite is , and such an item exists, it will be overwritten by the item specified by OldFileName. But if such an item exists, and Overwrite is , this method .

Note: The usual rules of deletion still apply for an item being overwritten. Notably, a nonempty directory cannot be overwritten.

Note: This method can be called only when Active is , and it cannot be called within events.

OpenFile Method (CBVaultDrive Module)

This method opens a new or existing file or alternate stream in the vault.

Syntax

• Swift
• Objective-C

public func openFile(fileName: String, openMode: Int32, readEnabled: Bool, writeEnabled: Bool, password: String) throws -> CBFSStorageStream

- (CBFSStorageStream*)openFile:(NSString*)fileName :(int)openMode :(BOOL)readEnabled :(BOOL)writeEnabled :(NSString*)password;

Remarks

This method opens the file or alternate stream specified by FileName, creating it if necessary based on the specified OpenMode, and returns a stream object that provides access to its data.

Note: Files and alternate streams cannot be created or written to if the vault is open in ReadOnly mode.

The value passed for FileName must be a vault-local absolute path.

The OpenMode parameter specifies what behavior to use when opening a file or alternate stream. Valid values are as follows:

The ReadEnabled and WriteEnabled parameters specify which kinds of access the returned stream object should permit.

Note: WriteEnabled is ignored if ReadOnly is .

The Password parameter works as follows:

• If the specified file or alternate stream already exists and is encrypted, the specified Password is used to decrypt and access its data.
• If a new file or alternate stream is created, and the DefaultFileEncryption property is not VAULT_EM_NONE, the specified Password is used to encrypt it.

Internally, this method simply calls OpenFileEx, passing on all shared parameters' values and using the following defaults for the others:

• ShareDenyRead and ShareDenyWrite use .
• Encryption uses the current DefaultFileEncryption value.
• Compression and CompressionLevel use the current DefaultFileCompression and DefaultFileCompressionLevel values, respectively.
• PagesPerBlock uses 16.

Note: This method can be called only when Active is , and it cannot be called within events.

OpenFileEx Method (CBVaultDrive Module)

This method opens a new or existing file or alternate stream in the vault.

Syntax

• Swift
• Objective-C

public func openFileEx(fileName: String, openMode: Int32, readEnabled: Bool, writeEnabled: Bool, shareDenyRead: Bool, shareDenyWrite: Bool, encryption: Int32, password: String, compression: Int32, compressionLevel: Int32, pagesPerBlock: Int32) throws -> CBFSStorageStream

- (CBFSStorageStream*)openFileEx:(NSString*)fileName :(int)openMode :(BOOL)readEnabled :(BOOL)writeEnabled :(BOOL)shareDenyRead :(BOOL)shareDenyWrite :(int)encryption :(NSString*)password :(int)compression :(int)compressionLevel :(int)pagesPerBlock;

Remarks

This method opens the file or alternate stream specified by FileName, creating it if necessary based on the specified OpenMode, and returns a stream object that provides access to its data.

Note: Files and alternate streams cannot be created or written to if the vault is open in ReadOnly mode.

The value passed for FileName must be a vault-local absolute path.

The OpenMode parameter specifies what behavior to use when opening a file or alternate stream. Valid values are as follows:

The ReadEnabled and WriteEnabled parameters specify which kinds of access the returned stream object should permit.

Note: WriteEnabled is ignored if ReadOnly is .

The ShareDenyRead and ShareDenyWrite parameters specify whether other accessors may read and/or write the specified file or alternate stream simultaneously. To prevent simultaneous read and/or write access, pass ; to allow it, pass .

The Encryption parameter specifies the encryption mode to use when creating a file or alternate stream. Valid values are as follows:

Applications that use custom encryption must implement at least the DataEncrypt and DataDecrypt events. Certain custom encryption modes may require that the HashCalculate or KeyDerive event be implemented as well. Please refer to the Encryption topic for more information.

The Password parameter works as follows:

• If the specified file or alternate stream already exists and is encrypted, the specified Password is used to decrypt and access its data.
• If a file or alternate stream is created, and Encryption is not VAULT_EM_NONE, the specified Password is used to encrypt it.

The Compression parameter specifies the compression mode to use when creating a file or alternate stream. Valid values are as follows:

Applications that use custom compression must implement the DataCompress and DataDecompress events. Please refer to the Compression topic for more information.

The CompressionLevel parameter specifies the compression level to use, if applicable.

The PagesPerBlock parameter specifies how many pages should be compressed as a single block, if applicable. Valid values are powers of 2 up to and including 128 (i.e., 2, 4, 8, 16, 32, 64, or 128), or 0, which is interpreted as "default" (currently 16 for both zlib and run-length encoding [RLE]). Larger values allow for more efficient compression; however, because a block must be decompressed (and, for writes, recompressed) anytime its data are accessed, larger values can also cause excessive slowdown, especially for random access.

Note: This method can be called only when Active is , and it cannot be called within events.

OpenRootData Method (CBVaultDrive Module)

This method opens the vault's root data stream.

Syntax

• Swift
• Objective-C

public func openRootData() throws -> CBFSStorageStream

- (CBFSStorageStream*)openRootData;

Remarks

This method opens the vault's root data stream, returning a stream object that provides access to its data.

Please refer to the Using RootData topic for more information.

Note: This method can be called only when Active is , and it cannot be called within events.

OpenVault Method (CBVaultDrive Module)

This method opens a new or existing vault.

Syntax

• Swift
• Objective-C

public func openVault(openMode: Int32, journalingMode: Int32) throws -> Void

- (void)openVault:(int)openMode :(int)journalingMode;

Remarks

This method opens a vault, creating it if necessary based on the specified OpenMode.

The OpenMode parameter specifies what behavior to use when opening a vault. Valid values are as follows:

The JournalingMode parameter specifies whether any form of journaling should be used when working with the vault. Valid values are as follows:

When a vault is being created or opened, the VaultFile and/or CallbackMode properties are used to specify its location. If CallbackMode is disabled (default), the class creates or opens a file-based vault at the path specified by VaultFile.

If CallbackMode is enabled, then the application controls where the vault is located and how it is accessed by the Vault* events (and the value held by VaultFile is simply passed to said events for the application to use). For brevity, vaults created and accessed using callback mode are referred to as "callback mode vaults"; please refer to the Callback Mode topic for more information.

The class also has a number of other properties and configuration settings used when creating or opening a vault, all of which are listed below. Please refer to each one's documentation for more information, including usage restrictions.

• AutoCompactAt property
• AutoCompactDelay configuration setting
• CaseSensitive property
• Logo property
• MaxNonPagedNameLength configuration setting
• PageSize property
• PartSize configuration setting
• PathSeparator property
• ReadOnly property
• UseAccessTime property
• UseSystemCache property

If a file-based vault's storage file (or the storage device it is located on) is marked as read-only, then the ReadOnly property must be enabled before this method is called. If an application attempts to open a vault with a read-only storage file in read-write mode, this method .

For the CBVaultDrive class on Windows, an attempt to open a vault file that is compressed or encrypted using NTFS capabilities will lead to an error being reported by this method. It is necessary to not use NTFS compression or encryption on the file to avoid a systemwide deadlock in Windows internals.

Note: This method cannot be called when Active is , and it cannot be called within events.

OpenVolume Method (CBVaultDrive Module)

Opens a storage volume or partition formatted with the CBFS Storage filesystem as a vault (Windows only).

Syntax

• Swift
• Objective-C

public func openVolume(volumeName: String, journalingMode: Int32) throws -> Void

- (void)openVolume:(NSString*)volumeName :(int)journalingMode;

Remarks

This method opens the storage volume or partition specified by VolumeName as a vault.

If the specified volume or partition is not formatted with the CBFS Storage filesystem, this method .

The JournalingMode parameter specifies whether any form of journaling should be used when working with the vault. Valid values are:

The VolumeName parameter specifies the fully-qualified name of a storage volume or partition. DOS names, such as X:, are also valid.

Note: This method cannot be called when Active is , and it cannot be called within events.

RegisterIcon Method (CBVaultDrive Module)

Registers an icon that can be displayed as an overlay on the virtual drive in Windows File Explorer (Windows only).

Syntax

• Swift
• Objective-C

public func registerIcon(iconPath: String, productGUID: String, iconId: String) throws -> Bool

- (BOOL)registerIcon:(NSString*)iconPath :(NSString*)productGUID :(NSString*)iconId;

Remarks

This method registers an icon in the file specified by IconPath so that it can later be used to display an overlay on the virtual drive in Windows File Explorer. If the system must be rebooted before the icon can be used, this method returns , otherwise it returns .

Please note that this method only registers overlay icons; Applications should call the SetIcon and ResetIcon methods to select an icon for display. Please refer to the Custom Drive Icons topic for more information.

IconPath must be the full path and file name of the .ico file whose icon should be registered. The file must exist and remain available in order for the icon to be used until the icon is unregistered using UnregisterIcon.

ProductGUID is used to distinguish between driver installations performed by different applications. Such information is necessary to guard against unexpected situations such as, e.g., the driver being uninstalled by one application despite other applications still needing it.

The GUID must be specified in so-called "Registry Format" (e.g., "{1FAD0EF2-9A03-4B87-B4BC-645B7035ED90}") with curly braces included.

To ensure proper operation, it is critical that each individual application have its own unique ProductGUID value, and that applications (and their installation scripts) use that value when calling any of the following methods:

• Install
• Uninstall
• GetDriverStatus
• GetModuleVersion
• RegisterIcon
• UnregisterIcon
• Initialize

IconId specifies an identifier that can later be passed to the SetIcon and UnregisterIcon methods. Each registered icon should have a unique IconId value; if a value is passed that is already in use, the existing icon will be removed (by calling UnregisterIcon internally) before the new one is registered.

This method is available in both the class API and the Installer DLL included with the product; please refer to the Driver Installation in Windows topic for more information about the latter. The Helper DLL must be installed in order for this method to function correctly. Applications can check to see whether the Helper DLL is installed using the GetModuleVersion method, and install it using the Install method if necessary.

This method requires administrative rights to execute successfully. If the user account of the process that calls this method doesn't have such rights, the call will fail with an ERROR_PRIVILEGE_NOT_HELD () error.

Note: This method cannot be called within events.

RemoveDeniedProcess Method (CBVaultDrive Module)

Removes a rule that prevents a process from accessing the virtual drive.

Syntax

• Swift
• Objective-C

public func removeDeniedProcess(processFileName: String, processId: Int32) throws -> Void

- (void)removeDeniedProcess:(NSString*)processFileName :(int)processId;

Remarks

When the ProcessRestrictionsEnabled property is enabled, this method can be used to remove an access rule previously added with the AddDeniedProcess method.

Pass the same values for ProcessFileName and ProcessId as were used to add the rule when AddDeniedProcess was called previously. Please refer to that method's documentation for more information.

Note: This method can be called only when Active is , and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

RemoveGrantedProcess Method (CBVaultDrive Module)

Removes a rule that allows a process to access the virtual drive.

Syntax

• Swift
• Objective-C

public func removeGrantedProcess(processFileName: String, processId: Int32) throws -> Void

- (void)removeGrantedProcess:(NSString*)processFileName :(int)processId;

Remarks

When the ProcessRestrictionsEnabled property is enabled, this method can be used to remove an access rule previously added with the AddGrantedProcess method.

Pass the same values for ProcessFileName and ProcessId as were used to add the rule when AddGrantedProcess was called previously. Please refer to that method's documentation for more information.

Note: This method can be called only when Active is , and it cannot be called within events.

The methods and properties related to process access lists are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of process access information occurs in a thread-safe manner.

RemoveMountingPoint Method (CBVaultDrive Module)

Removes a mounting point for the virtual drive.

Syntax

• Swift
• Objective-C

public func removeMountingPoint(index: Int32, mountingPoint: String, flags: Int32, authenticationId: Int64) throws -> Void

- (void)removeMountingPoint:(int)index :(NSString*)mountingPoint :(int)flags :(long long)authenticationId;

Remarks

This method removes a previously-created mounting point for the virtual drive.

Index must be set to the index of an item in the MountingPoint* properties, or to -1 to remove an item based on the other method parameters.

If Index is -1, then the same values must be passed for MountingPoint, Flags, AuthenticationId as were used to add the mounting point when AddMountingPoint was called previously. Please refer to that method's documentation for more information. (If Index is not -1, these parameters are ignored.)

The sgSTGMPDRIVELETTERNOTIFYASYNC; flag may be passed in Flags to send notifications about removal of the mounting point asynchronously. Do not use this flag if the process quits right after a call to this method because asynchronous delivery involves a secondary thread, which will be terminated when the process quits.

Note: This method cannot be called within events.

The methods and properties related to mounting points are not intended to be used from multiple threads at once. Applications that wish to use said methods and properties from multiple threads are responsible for employing proper thread synchronization techniques to ensure that manipulation and enumeration of mounting points occurs in a thread-safe manner.

ResetIcon Method (CBVaultDrive Module)

Resets the virtual drive's icon back to default by deselecting the active overlay icon (Windows only).

Syntax

• Swift
• Objective-C

public func resetIcon() throws -> Void

- (void)resetIcon;

Remarks

This method deselects the overlay icon currently in use, thus resetting the virtual drive's icon back to its default state (i.e., displayed without any overlay icons).

Please refer to the SetIcon method, as well as the Custom Drive Icons topic, for more information.

The Helper DLL must be installed in order for this method to function correctly. Applications can check to see whether the Helper DLL is installed using the GetModuleVersion method, and install it using the Install method if necessary.

Note: This method can be called only after creating a virtual drive, and it cannot be called within events.

ResolveLink Method (CBVaultDrive Module)

This method retrieves the destination of a symbolic link.

Syntax

• Swift
• Objective-C

public func resolveLink(linkName: String, normalize: Bool) throws -> String

- (NSString*)resolveLink:(NSString*)linkName :(BOOL)normalize;

Remarks

This method retrieves the destination pointed to by the symbolic link specified by LinkName.

The value passed for LinkName must be a vault-local absolute path.

As the CreateLink method's documentation describes, symbolic links can be created with either relative or absolute vault-local paths. The Normalize parameter specifies whether the class should normalize the specified link's destination before returning it. Passing will ensure a vault-local absolute path is always returned; passing will cause the original destination path to be returned.

Note: This method can be called only when Active is .

SetFileAttributes Method (CBVaultDrive Module)

This method sets the attributes of a vault item.

Syntax

• Swift
• Objective-C

public func setFileAttributes(fileName: String, attributes: Int32) throws -> Void

- (void)setFileAttributes:(NSString*)fileName :(int)attributes;

Remarks

This method sets the attributes of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The Attributes parameter specifies the new attributes for the vault item, which should be constructed by ORing together one or more of the following values:

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileCompression Method (CBVaultDrive Module)

This method compresses or decompresses a file or alternate stream.

Syntax

• Swift
• Objective-C

public func setFileCompression(fileName: String, compression: Int32, compressionLevel: Int32, pagesPerBlock: Int32, password: String) throws -> Void

- (void)setFileCompression:(NSString*)fileName :(int)compression :(int)compressionLevel :(int)pagesPerBlock :(NSString*)password;

Remarks

This method changes the compression mode used to compress the file or alternate stream specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The Compression parameter specifies the new compression mode to use. Valid values are as follows:

Applications that use custom compression must implement the DataCompress and DataDecompress events. Please refer to the Compression topic for more information.

The CompressionLevel parameter specifies the compression level to use, if applicable.

The PagesPerBlock parameter specifies how many pages should be compressed as a single block, if applicable. Valid values are powers of 2 up to and including 128 (i.e., 2, 4, 8, 16, 32, 64, or 128), or 0, which is interpreted as "default" (currently 16 for both zlib and run-length encoding [RLE]). Larger values allow for more efficient compression; however, because a block must be decompressed (and, for writes, recompressed) anytime its data are accessed, larger values can also cause excessive slowdown, especially for random access.

The Password parameter specifies the password to use to access the file's data, if it is encrypted.

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileCreationTime Method (CBVaultDrive Module)

This method sets the creation time of a vault item.

Syntax

• Swift
• Objective-C

public func setFileCreationTime(fileName: String, creationTime: Date) throws -> Void

- (void)setFileCreationTime:(NSString*)fileName :(NSDate*)creationTime;

Remarks

This method sets the creation time of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The CreationTime parameter specifies the new creation time for the vault item, which must be specified .

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileEncryption Method (CBVaultDrive Module)

This method encrypts, decrypts, or changes the encryption password of a file or alternate stream.

Syntax

• Swift
• Objective-C

public func setFileEncryption(fileName: String, encryption: Int32, oldPassword: String, newPassword: String) throws -> Void

- (void)setFileEncryption:(NSString*)fileName :(int)encryption :(NSString*)oldPassword :(NSString*)newPassword;

Remarks

This method changes the encryption mode or password used to encrypt the file or alternate stream specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The Encryption parameter specifies the new encryption mode to use. Valid values are as follows:

Applications that use custom encryption must implement at least the DataEncrypt and DataDecrypt events. Certain custom encryption modes may require that the HashCalculate or KeyDerive event be implemented as well. Please refer to the Encryption topic for more information.

The OldPassword parameter specifies the current encryption password, if applicable.

The NewPassword parameter specifies the new encryption password to use, if applicable.

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileLastAccessTime Method (CBVaultDrive Module)

This method sets the last access time of a vault item.

Syntax

• Swift
• Objective-C

public func setFileLastAccessTime(fileName: String, lastAccessTime: Date) throws -> Void

- (void)setFileLastAccessTime:(NSString*)fileName :(NSDate*)lastAccessTime;

Remarks

This method sets the last access time of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The LastAccessTime parameter specifies the new last access time for the vault item, which must be specified .

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileModificationTime Method (CBVaultDrive Module)

This method sets the modification time of a vault item.

Syntax

• Swift
• Objective-C

public func setFileModificationTime(fileName: String, modificationTime: Date) throws -> Void

- (void)setFileModificationTime:(NSString*)fileName :(NSDate*)modificationTime;

Remarks

This method sets the modification time of the vault item (e.g., file, directory, symbolic link, or alternate stream) specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The ModificationTime parameter specifies the new modification time for the vault item, which must be specified .

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileSize Method (CBVaultDrive Module)

This method sets the size of a file or alternate stream.

Syntax

• Swift
• Objective-C

public func setFileSize(fileName: String, size: Int64, password: String) throws -> Void

- (void)setFileSize:(NSString*)fileName :(long long)size :(NSString*)password;

Remarks

This method sets the size of the file or alternate stream specified by FileName.

The value passed for FileName must be a vault-local absolute path.

The Size parameter specifies the new size of the file or alternate stream, which must be greater than or equal to 0.

Applications can also change the size of a file or alternate stream using the stream objects returned by the OpenFile and OpenFileEx methods.

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileTag Method (CBVaultDrive Module)

This method attaches a raw file tag with binary data to the specified vault item.

Syntax

• Swift
• Objective-C

public func setFileTag(fileName: String, tagId: Int32, data: Data) throws -> Void

- (void)setFileTag:(NSString*)fileName :(int)tagId :(NSData*)data;

Remarks

This method attaches a raw file tag with binary data to the vault item (e.g., file, directory, or alternate stream) specified by FileName using the specified TagId. If a raw file tag with the specified TagId is already attached to the specified vault item, it is replaced.

The value passed for FileName must be a vault-local absolute path. The value passed for TagId must be in the range 0x0001 to 0xCFFF (inclusive).

The Data parameter specifies the raw binary data to store in the file tag; it may be up to 65531 bytes in length.

Please refer to the File Tags topic for more information.

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileTagAsAnsiString Method (CBVaultDrive Module)

This method attaches an AnsiString-typed file tag to the specified vault item.

Syntax

• Swift
• Objective-C

public func setFileTagAsAnsiString(fileName: String, tagName: String, value: String) throws -> Void

- (void)setFileTagAsAnsiString:(NSString*)fileName :(NSString*)tagName :(NSString*)value;

Remarks

This method attaches an AnsiString-typed file tag to the vault item (e.g., file, directory, or alternate stream) specified by FileTag using the specified TagName. If a typed file tag with the specified TagName is already attached to the specified vault item, it is replaced.

The value passed for FileName must be a vault-local absolute path. The value passed for TagName may be up to 4095 characters in length (not including the null terminator).

The Value parameter specifies the AnsiString value to store in the file tag; it may be up to 65529 - (name_length * 2) bytes in length (where name_length is measured in characters), including null terminators for both the AnsiString value and the name.

Please refer to the File Tags topic for more information.

Note: AnsiString file tag values are converted to UTF-16LE when referenced in a search query string. To reduce the chance of string-conversion-related issues, it is recommended that applications only store ASCII characters in AnsiString-typed file tags, and prefer String-typed file tags (created using SetFileTagAsString) in all other cases.

Note: This method can be called only when Active is , and it cannot be called within events.

SetFileTagAsBoolean Method (CBVaultDrive Module)

This method attaches a Boolean-typed file tag to the specified vault item.

Syntax

• Swift
• Objective-C

public func setFileTagAsBoolean(fileName: String, tagName: String, value: Bool) throws -> Void

- (void)setFileTagAsBoolean:(NSString*)fileName :(NSString*)tagName :(BOOL)value;