ToiStorageDevicePartitionInfo Interface Reference

---

Description

This is the documentation for ToiStorageDevicePartitionInfo.
Information about a specific partition. Use toi.statics.ToiStorageDevicePartitionInfo.create(<id>, <uniqueId>, <isMounted>, <mountPoint>, <capacity>, <freeCapacity>, <fsStatus>, <isReadWrite>, <featureCapabilityMask>, <enabledFeatureMask>) to create an instance of ToiStorageDevicePartitionInfo. The following parameters in the create method are optional: <isReadWrite>, <featureCapabilityMask>, <enabledFeatureMask>. For the optional members that have default values, the values are: ; if they are not set from the portal, they will have the default value.

import "ToiStorageDevicePartitionInfo.idl";

List of all members.

Public Attributes
attribute ToiStorageDevice::TToiPartitionId	id
attribute string	uniqueId
attribute boolean	isMounted
attribute string	mountPoint
attribute long long	capacity
attribute long long	freeCapacity
attribute ToiStorageDevice::TToiFileSystemStatus	fsStatus
attribute boolean	isReadWrite
attribute long	featureCapabilityMask
attribute long	enabledFeatureMask

---

Member Data Documentation

attribute long long ToiStorageDevicePartitionInfo::capacity

Total partition capacity in bytes. This is total space on the partition. Including any reserved space.

attribute long ToiStorageDevicePartitionInfo::enabledFeatureMask

Technical Preview:

This field is a TECHNICAL PREVIEW, it may change. Partition enabled features (ToiStorageDevice::TToiPartitionFeature)

attribute long ToiStorageDevicePartitionInfo::featureCapabilityMask

Technical Preview:

This field is a TECHNICAL PREVIEW, it may change. Partition supported features (ToiStorageDevice::TToiPartitionFeature)

attribute long long ToiStorageDevicePartitionInfo::freeCapacity

Free partition capacity in bytes. This is the amount of space currently available for user data. The space reserved for platform data and any timeshift buffers owned by the platform is subtracted from this value. When FreeCapacity is zero all applicable features (like DVR) will be suspended and the ToiStorageDevicePartitionFullEvent event will occur.

attribute ToiStorageDevice::TToiFileSystemStatus ToiStorageDevicePartitionInfo::fsStatus

Partition fs check result from last reboot.

attribute ToiStorageDevice::TToiPartitionId ToiStorageDevicePartitionInfo::id

Identifier of the partition. Persistent between reboots if no change to partition.

attribute boolean ToiStorageDevicePartitionInfo::isMounted

True if partition has been mounted.

attribute boolean ToiStorageDevicePartitionInfo::isReadWrite

Technical Preview:

TECHNICAL PREVIEW - This member may be removed. Read/Write status of the filesystem. Only valid if IsMounted is true. True if filesystem is mounted as read/write.

attribute string ToiStorageDevicePartitionInfo::mountPoint

The mount point directory.

attribute string ToiStorageDevicePartitionInfo::uniqueId

UUID of partition. This is a unique identifier that is persistent between reboots if no change to partitions is made.