CBMemDrive Component
Properties Methods Events Configuration Settings Errors
The CBMemDrive component lets applications create an in-memory vault, accessible to all or some processes as a regular disk.
Syntax
cbfsstorage.CBMemDrive
Remarks
The CBMemDrive component allows applications to create an in-memory vault and interact with its contents directly. A vault can contain any number of files, directories, alternate streams, and symbolic links; so long as it has sufficient capacity to store them. For more information about using CBFS Storage's many features, please refer to the extensive General Information topics.
No data is ever stored on disk, all data is stored in memory. The CBMemDrive component is available on all platforms, supported by the CBFS Storage product.
Getting Started
Each CBMemDrive component instance can control a single vault at once. Applications can use multiple instances of the CBMemDrive component if their use-case requires multiple vaults.
Here's how to get up and running:
- Create or open a vault by calling the CreateVault method.
- Interact with the vault, and its contents, using the CBMemDrive component's API methods.
- When done, call the CloseVault method to close the vault.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AccessDeniedProcessCount | The number of records in the AccessDeniedProcess arrays. |
AccessDeniedProcessDesiredAccess | The kind of access granted or denied. |
AccessDeniedProcessIncludeChildren | Whether child processes are affected. |
AccessDeniedProcessId | The Id of the target process. |
AccessDeniedProcessName | The filename of the target process's executable. |
AccessGrantedProcessCount | The number of records in the AccessGrantedProcess arrays. |
AccessGrantedProcessDesiredAccess | The kind of access granted or denied. |
AccessGrantedProcessIncludeChildren | Whether child processes are affected. |
AccessGrantedProcessId | The Id of the target process. |
AccessGrantedProcessName | The filename of the target process's executable. |
Active | Whether a vault has been opened and mounted as a virtual drive. |
AutoCompactAt | The free space percentage threshold a vault must reach to be eligible for automatic compaction. |
CaseSensitive | Whether the component should open a vault in case-sensitive mode. |
DefaultFileCompression | The default compression mode to use when creating files and alternate streams. |
DefaultFileEncryption | The default encryption mode to use when creating files and alternate streams. |
DefaultFilePassword | The default encryption password to use when creating or opening files and alternate streams. |
FileSystemName | The name of the virtual filesystem. |
IsCorrupted | Whether the vault is corrupted. |
LastWriteTime | The last modification time of the vault. |
Logo | An application-defined text-based logo stored in the second page of a vault. |
MountingPointCount | The number of records in the MountingPoint arrays. |
MountingPointAuthenticationId | The Authentication ID used when creating the mounting point, if applicable. |
MountingPointFlags | The flags used to create the mounting point. |
MountingPointName | The mounting point name. |
PageSize | The vault's page size. |
PathSeparator | The path separator character to use when returning vault paths. |
PossibleFreeSpace | The maximum amount of free space the vault could possibly have available. |
PossibleSize | The maximum size the vault could possibly be. |
ProcessRestrictionsEnabled | Whether process access restrictions are enabled. |
ReadOnly | Whether the component should open a vault in read-only mode. |
ReportPossibleSize | How the component should report the virtual drive's size and free space to the OS. |
StorageCharacteristics | The characteristic flags to create the virtual drive with. (Windows only). |
StorageType | The type of virtual drive to create. (Windows only). |
Tag | Stores application-defined data specific to this instance of the component. |
Timeout | How long vault events may execute before timing out. (Windows only). |
UseAccessTime | Whether the component should keep track of last access times for vault items. |
VaultEncryption | The whole-vault encryption mode. |
VaultFreeSpace | The actual amount of free space the vault has available. |
VaultPassword | The whole-vault encryption password. |
VaultSize | The actual size of the vault. |
VaultSizeMax | The maximum size a vault can be. |
VaultSizeMin | The minimum size a vault can be. |
VaultState | Information about the state of the vault. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AddDeniedProcess | Adds a rule that prevents a process from accessing the virtual drive. |
AddGrantedProcess | Adds a rule that allows a process to access the virtual drive. |
AddMountingPoint | Adds a mounting point for the virtual drive. |
CacheFilePassword | Caches an encryption password to use the next time a file or alternate stream is accessed. |
CheckAndRepair | Checks a vault's consistency and repairs it as necessary. |
CheckFilePassword | Verifies whether a particular file password is correct. |
CheckVaultPassword | Verifies whether a particular vault password is correct. |
CloseVault | Closes the vault. |
CompactVault | Compacts the vault. |
Config | Sets or retrieves a configuration setting. |
ConvertToDrivePath | Converts a vault-local vault item path to a virtual drive file path. |
ConvertToVaultPath | Converts a virtual drive file path to a vault-local vault item path. |
CreateDirectory | Creates a new directory in the vault. |
CreateLink | Creates a symbolic link to another file in the vault. |
CreateVault | Creates an in-memory vault. |
DeleteFile | Deletes a vault item. |
DeleteFileTag | Deletes a file tag. |
FileExists | Checks whether a vault item exists. |
FileMatchesMask | Checks whether a particular file or directory name matches the specified mask. |
FileTagExists | Checks whether a file tag exists. |
FindClose | Closes a search operation and releases any associated resources. |
FindFirst | Searches for the first vault item that matches the specified name and attributes. |
FindFirstByQuery | Searches for the first file or directory whose file tags match the specified query. |
FindNext | Searches for the next vault item that matches an ongoing search operation. |
GetDriverStatus | Retrieves the status of the system driver. |
GetFileAttributes | Retrieves the attributes of a vault item. |
GetFileCompression | Retrieves the compression mode of a file or alternate stream. |
GetFileCreationTime | Retrieves the creation time of a vault item. |
GetFileEncryption | Retrieves the encryption mode of a file or alternate stream. |
GetFileLastAccessTime | Retrieves the last access time of a vault item. |
GetFileModificationTime | Retrieves the modification time of a vault item. |
GetFileSize | Retrieves the size of a file or alternate stream. |
GetFileTag | Retrieves the binary data held by a raw file tag attached to the specified vault item. |
GetFileTagAsAnsiString | Retrieves the value of an AnsiString-typed file tag attached to the specified vault item. |
GetFileTagAsBoolean | Retrieves the value of a Boolean-typed file tag attached to the specified vault item. |
GetFileTagAsDateTime | Retrieves the value of a DateTime-typed file tag attached to the specified vault item. |
GetFileTagAsNumber | Retrieves the value of a Number-typed file tag attached to the specified vault item. |
GetFileTagAsString | Retrieves the value of a String-typed file tag attached to the specified vault item. |
GetFileTagDataType | Retrieves the data type of a typed file tag attached to a specific vault item. |
GetFileTagSize | Retrieves the size of a raw file tag attached to the specified vault item. |
GetModuleVersion | Retrieves the version of a given product module. |
GetOriginatorProcessId | Retrieves the Id of the process (PID) that initiated the operation. |
GetOriginatorProcessName | Retrieves the name of the process that initiated the operation. |
GetOriginatorThreadId | Retrieves the Id of the thread that initiated the operation. (Windows only). |
GetOriginatorToken | Retrieves the security token associated with the process that initiated the operation. (Windows only). |
GetSearchResultAttributes | Retrieves the attributes of a vault item found during a search operation. |
GetSearchResultCreationTime | Retrieves the creation time of a vault item found during a search operation. |
GetSearchResultFullName | Retrieves the fully-qualified name of a vault item found during a search operation. |
GetSearchResultLastAccessTime | Retrieves the last access time of a vault item found during a search operation. |
GetSearchResultLinkDestination | Retrieves the destination of a symbolic link found during a search operation. |
GetSearchResultMetadataSize | Retrieves the size of the metadata associated with a vault item found during a search operation. |
GetSearchResultModificationTime | Retrieves the modification time of a vault item found during a search operation. |
GetSearchResultName | Retrieves the name of a vault item found during a search operation. |
GetSearchResultSize | Retrieves the size of a vault item found during a search operation. |
Initialize | Initializes the component. |
Install | Installs (or upgrades) the product's system drivers and/or helper DLL. (Windows only). |
IsDirectoryEmpty | Checks whether a directory is empty. |
IsIconRegistered | Checks whether the specified icon is registered. |
LoadFromFile | Copies contents of a file-based vault into the in-memory vault. |
MoveFile | Renames or moves a vault item. |
OpenFile | Opens a new or existing file or alternate stream in the vault. |
OpenFileEx | Opens a new or existing file or alternate stream in the vault. |
OpenRootData | Opens the vault's root data stream. |
RegisterIcon | Registers an icon that can be displayed as an overlay on the virtual drive in Windows Explorer. |
RemoveDeniedProcess | Removes a rule that prevents a process from accessing the virtual drive. |
RemoveGrantedProcess | Removes a rule that allows a process to access the virtual drive. |
RemoveMountingPoint | Removes a mounting point for the virtual drive. |
ResetIcon | Resets the virtual drive's icon back to default by deselecting the active overlay icon. |
ResolveLink | Retrieves the destination of a symbolic link. |
SaveToFile | Copies contents of the in-memory vault into a file-based vault. |
SetFileAttributes | Sets the attributes of a vault item. |
SetFileCompression | Compresses or decompresses a file or alternate stream. |
SetFileCreationTime | Sets the creation time of a vault item. |
SetFileEncryption | Encrypts, decrypts, or changes the encryption password of a file or alternate stream. |
SetFileLastAccessTime | Sets the last access time of a vault item. |
SetFileModificationTime | Sets the modification time of a vault item. |
SetFileSize | Sets the size of a file or alternate stream. |
SetFileTag | Attaches a raw file tag with binary data to the specified vault item. |
SetFileTagAsAnsiString | Attaches an AnsiString-typed file tag to the specified vault item. |
SetFileTagAsBoolean | Attaches a Boolean-typed file tag to the specified vault item. |
SetFileTagAsDateTime | Attaches a DateTime-typed file tag to the specified vault item. |
SetFileTagAsNumber | Attaches a Number-typed file tag to the specified vault item. |
SetFileTagAsString | Attaches a String-typed file tag to the specified vault item. |
SetIcon | Selects a registered overlay icon for display on the virtual drive in Windows Explorer. |
ShutdownSystem | Shuts down or reboots the operating system. |
Uninstall | Uninstalls the product's system drivers and/or helper DLL. (Windows only). |
UnregisterIcon | Unregisters an existing overlay icon. |
UpdateVaultEncryption | Encrypts, decrypts, or changes the encryption password of the vault. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
Ejected | Fires when the media and virtual drive have been ejected. |
Error | Fires if an unhandled error occurs during an event. |
FilePasswordNeeded | Fires if a password is needed to open an encrypted file. |
Progress | Fires to indicate the progress of long-running vault operations. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
AllowMoveStreamsBetweenFiles | Whether alternate streams may be moved from one file to another. |
AlwaysJournalMetadata | Whether filesystem structure is always saved during modification, like in Journaling mode. |
AsyncDeleteStorageNotifications | Whether system broadcasts for virtual drive deletion are sent asynchronously. |
AutoCompactDelay | How long a vault must remain idle before starting automatic compaction. |
DefaultFileCompressionLevel | The default compression level to use when creating files and alternate streams. |
LoggingEnabled | Whether extended logging is enabled. |
MaxNonPagedNameLength | The maximum number of name characters to store directly within a vault item. |
SupportSearchIndexer | Specifies whether the driver must take additional measures to support indexing by Windows Search. |
VolumeGuidName | The GUID of the mounted volume. |