beautypg.com

Rostorageinfo – BrightSign Object Reference Manual (FW 5.1) User Manual

Page 168

background image

160

roStorageInfo

This object is used to report storage device usage information.

Object Creation: The roStorageInfo object is created with a parameter that specifies the path of the storage device. The
path does not need to extend to the root of the storage device.

CreateObject("roStorageInfo", path As String)

Interfaces: ifStorageInfo

The ifStorageInfo interface provides the following:

Note: On some filesystems that have a portion of space reserved for the super-user, the following expression may not be
true:

GetUsedInMegabytes + GetFreeInMegabytes == GetSizeInMegabytes

GetFailureReason() As String: Yields additional useful information if a function return indicates an error.

GetBytesPerBlock() As Integer: Returns the size of a native block on the filesystem used by the specified
storage device.

GetSizeInMegabytes() As Integer: Returns the total size (in mebibytes) of the storage device.

GetUsedInMegabytes() As Integer: Returns the amount (in mebibytes) of space currently used on the
storage device.
Note: This amount includes the size of the pool because this class does not integrate pools into its calculations.

GetFreeInMegabytes() As Integer: Returns the available space (in mebibytes) on the storage device.

GetFileSystemType() As String: Returns a string describing the type of filesystem used on the specified
storage. Potential values are fat12, fat16, fat32, ext3, ntfs, hfs, Hfsplus.

GetStorageCardInfo() As Object: Returns an associative array containing details of the storage device
hardware (a memory card, for example). For SD cards, the returned data may include the following: