CBDirect Class
Properties Methods Events Configuration Settings Errors
The CBDirect class provides applications with low-level, direct access to disks and memory in Windows.
Syntax
class cbfsdirect.CBDirect
Remarks
The CBDirect class is used to gain low-level, direct access to disks and memory in Windows. The class allows bypassing certain Windows access restrictions, even under limited user accounts.
Getting Started
All of the CBDirect class's methods are independent, and can be called immediately after creating an instance of the class.
Here's how to get up and running:
- If the system driver hasn't been installed yet, call the install method to do so. This only needs to be done once.
- In production, the system driver can be installed (or updated) ahead-of-time by the application's installation script using the Installer DLL. Please refer to the Driver Installation topic for more information.
- Call the class's methods as needed.
- To uninstall the system driver, call the uninstall method. This should not be done as part of the driver upgrade process.
- In production, the system driver can be uninstalled by the application's uninstallation script using the Installer DLL. Please refer to the Driver Installation topic for more information.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| tag | Stores application-defined data specific to this instance of the class. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| create_file | Creates or opens a file or directory by passing the request directly to the filesystem. |
| create_file_as_stream | Creates or opens a file as a stream by passing the request directly to the filesystem. |
| delete_file | Deletes a file by passing the request directly to the filesystem. |
| get_driver_status | Retrieves the status of the class's system driver. |
| get_driver_version | Retrieves the version of the class's system driver. |
| get_sector_count | Returns the number of sectors on the specified disk device. |
| get_sector_size | Returns the sector size used by the specified disk device. |
| initialize | Initializes the class. |
| install | Installs (or upgrades) the class's system driver. |
| open_memory | Provides raw, read-only access to the system's physical memory. |
| open_memory_as_stream | Provides raw, read-only access to the system's physical memory as a stream. |
| open_volume | Opens a volume. |
| open_volume_as_stream | Opens a volume as a stream. |
| read_sectors | Reads data from sectors of a disk. |
| shutdown_system | Shuts down or reboots the operating system. |
| uninstall | Uninstalls the class's system driver. |
| write_sectors | Writes data to sectors on a disk. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Fires if an unhandled error occurs during an event. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| BuildInfo | Information about the product's build. |
| LicenseInfo | Information about the current license. |