Queries the meta data of file system volumes.
The StorageDevice class returns the meta data of file system volumes. A reference to an existing volume is required in the Volume field in order to make a successful analysis. If the volume name cannot be resolved, initialisation will fail.
Following initialisation, all meta fields describing the volume are readable for further information.
The StorageDevice class consists of the following fields:
Access | Name | Type | Comment | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BytesFree | BIGINT | Total amount of storage space that is available, measured in bytes. | |||||||||||||||||||||||||||||||||||||||||||
| BytesUsed | BIGINT | Total amount of storage space in use. | |||||||||||||||||||||||||||||||||||||||||||
The total amount of storage space used by the device is indicated in this field. Please note that storage usage is typically measured in terms of blocks. For instance a block size of 512 bytes will mean that this field will be a multiple of 512. Two files of 1 byte each on such a file system would take up 1024 bytes of space and not 2. | |||||||||||||||||||||||||||||||||||||||||||||
| DeviceFlags | DEVICE | These read-only flags identify the type of device and its features. | |||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||
| DeviceID | STRING | A unique ID for the mounted device (platform dependent, NULL if unavailable). | |||||||||||||||||||||||||||||||||||||||||||
If a volume expresses a unique device identifier such as a factory serial number, it will be readable from this field. | |||||||||||||||||||||||||||||||||||||||||||||
| DeviceSize | BIGINT | The storage size of the device in bytes, without accounting for the file system format. | |||||||||||||||||||||||||||||||||||||||||||
This field indicates the storage size of the device. It does not reflect the available space determined by the device's file system, which will typically be measurably smaller than this value. | |||||||||||||||||||||||||||||||||||||||||||||
| Volume | STRING | The volume name of the device to query. | |||||||||||||||||||||||||||||||||||||||||||
Set the Volume field prior to initialisation for that volume to be queried by the object. The standard volume string format is | |||||||||||||||||||||||||||||||||||||||||||||
| Name | Description |
|---|---|
| DEVICE::BOOKMARK | This marker indicates that the presented volume is a bookmark and not a device name. |
| DEVICE::COMPACT_DISC | Compact disc style device |
| DEVICE::FIXED | Catch-all for fixed media devices that are not directly identifiable. |
| DEVICE::FLOPPY_DISK | Floppy disk style device |
| DEVICE::HARD_DISK | Hard disk style device |
| DEVICE::MEMORY | Device is RAM, ROM, WORM, NVRAM, flashdisk or other form of memory. Does not guarantee a fast connection as it could be over a slow USB 1.1 connection for example |
| DEVICE::MODEM | Device is a modem. |
| DEVICE::NETWORK | Device represents a network link |
| DEVICE::PRINTER | Device is a paper-based printer. |
| DEVICE::PRINTER_3D | Device is a three dimensional printer. |
| DEVICE::READ | Device is readable |
| DEVICE::REMOVABLE | Device media is removable from the hardware |
| DEVICE::REMOVEABLE | Device media is removable from the hardware |
| DEVICE::SCANNER | Device is a two dimensional scanner. |
| DEVICE::SCANNER_3D | Device is a three dimensional scanner. |
| DEVICE::SOFTWARE | Device is virtual/software defined |
| DEVICE::TAPE | Tape/Stream style device |
| DEVICE::TEMPORARY | All storage is temporary |
| DEVICE::USB | Removable USB storage device. May be further qualified by HARD_DISK, FLOPPY_DISK etc |
| DEVICE::WRITE | Device is writeable |