Package prlsdkapi :: Class StatDisk
[hide private]
[frames] | no frames]

Class StatDisk

object --+    
         |    
   _Handle --+
             |
            StatDisk

Provides methods for obtaining disk statistics for the host computer or a virtual machine. To obtain the object, use the Statistics.get_disk_stat method.

Instance Methods [hide private]
 
get_system_name(self)
Return the disk device name.
 
get_usage_disk_space(self)
Returns the size of the used space on the disk, in bytes.
 
get_free_disk_space(self)
Return free disk space, in bytes.
 
get_parts_stats_count(self)
Return the number of StatDiskPart objects contained in this StatDisk object.
 
get_part_stat(self, nIndex)
Return a StatDiskPart object specified by an index.

Inherited from _Handle: __del__, __init__, add_ref, free, from_string, get_handle_type, get_package_id, get_type

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

get_system_name(self)

 

Return the disk device name.

Returns:
An integer containing the disk device name.

get_usage_disk_space(self)

 

Returns the size of the used space on the disk, in bytes.

Returns:
An integer containing the used space size, in bytes.

get_free_disk_space(self)

 

Return free disk space, in bytes.

Returns:
An integer containing free disk space in bytes.

get_parts_stats_count(self)

 

Return the number of StatDiskPart objects contained in this StatDisk object. Each object contains statistics for an individual disk partition. Use the number returned to iterate through the object list and obtain individual objects using the Statistics.get_part_stat method.

Returns:
Integer. The number of StatDiskPart objects contained in this StatDisk object.

get_part_stat(self, nIndex)

 

Return a StatDiskPart object specified by an index. To obtain the number of objects in the list, use the Statistics.get_parts_stats_count method.

Parameters:
  • nIndex - Integer. An index of an object in the list (begins with 0).
Returns:
A StatDiskPart object containing statistis for a given disk partition.