MSFT_MTDiskVolume class

The disk volume data object.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Core::CoreElements"), AMENDMENT]
class MSFT_MTDiskVolume : CIM_ManagedElement
{
  string  InstanceID;
  string  Caption;
  string  Description;
  string  ElementName;
  uint64  FormattedSize;
  string  VolumePath;
  boolean SystemDisk;
  boolean PageFile;
};

Members

The MSFT_MTDiskVolume class has these types of members:

• Properties

Properties

The MSFT_MTDiskVolume class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The Caption property is a short textual description (one- line string) of the object.

This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

Gets a user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of CIM_ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of CIM_LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

This property is inherited from CIM_ManagedElement.

FormattedSize

Data type: uint64

Access type: Read-only

Gets the formatted disk size on the disk volume.

InstanceID

Data type: string

Access type: Read-only

InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: "OrgID:LocalID" Where OrgID and LocalID are separated by a colon (:), and where OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, OrgID must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between OrgID and LocalID. LocalID is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the OrgID set to "CIM".

This property is inherited from CIM_ManagedElement.

PageFile

Data type: boolean

Access type: Read-only

Gets a value that indicates true if the disk volume has a page file that the operating system is using; otherwise, false.

SystemDisk

Data type: boolean

Access type: Read-only

Gets a value that indicates true if the disk volume is a system disk on which the operating system has been installed; otherwise, false.

VolumePath

Data type: string

Access type: Read-only

Gets the logical path of the disk volume on the computer system.

Requirements

See also

CIM_ManagedElement

Management Tools Task Manager WMI Provider