Changeset 15486 in vbox for trunk/src

Timestamp:

Dec 15, 2008 9:57:20 AM (16 years ago)

Author:

vboxsync

Message:

API: add IHardDisk2::Compact, at the moment just a stub returning not implemented.

Location:

trunk/src/VBox/Main

Files:

• HardDisk2Impl.cpp (modified) (1 diff)
• idl/VirtualBox.xidl (modified) (1 diff)
• include/HardDisk2Impl.h (modified) (1 diff)

trunk/src/VBox/Main/HardDisk2Impl.cpp

@@ -1313 +1313 @@
 
 STDMETHODIMP HardDisk2::FlattenTo (IHardDisk2 *aTarget, IProgress **aProgress)
+{
+    AutoCaller autoCaller (this);
+    CheckComRCReturnRC (autoCaller.rc());
+
+    ReturnComNotImplemented();
+}
+
+STDMETHODIMP HardDisk2::Compact (IProgress **aProgress)
 {
     AutoCaller autoCaller (this);

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -8513 +8513 @@
     </method>
 
+    <method name="compact">
+      <desc>
+        Starts compacting of this hard disk. This means that the disk is
+        transformed into a possibly more compact storage representation.
+        This potentially creates temporary images, which can require a
+        substantial amount of additional disk space.
+
+        After the returned progress object reports that the operation is
+        successfully complete, the media state will be set back to the
+        current state.
+
+        <note>
+          This hard disk and all its parent hard disks will be placed to <link
+          to="MediaState_LockedRead"/> state for the duration of this
+          operation.
+        </note>
+      </desc>
+      <param name="progress" type="IProgress" dir="return">
+        <desc>Progress object to track the operation completion.</desc>
+      </param>
+    </method>
+
   </interface>
 

trunk/src/VBox/Main/include/HardDisk2Impl.h

@@ -113 +113 @@
     STDMETHOD(CloneTo) (IHardDisk2 *aTarget, IProgress **aProgress);
     STDMETHOD(FlattenTo) (IHardDisk2 *aTarget, IProgress **aProgress);
+    STDMETHOD(Compact) (IProgress **aProgress);
 
     // public methods for internal purposes only