Changeset 29028 in vbox

Timestamp:

May 4, 2010 2:33:45 PM (15 years ago)

Author:

vboxsync

Message:

Main/Medium: New API method for directly querying the MediumFormat object associated with a medium object. Getting the backend name and then use the list of all medium format objects to find it is lots of work and quite inefficient.

Location:

trunk/src/VBox/Main

Files:

• MediumImpl.cpp (modified) (5 diffs)
• idl/VirtualBox.xidl (modified) (2 diffs)
• include/MediumImpl.h (modified) (3 diffs)

trunk/src/VBox/Main/MediumImpl.cpp

@@ -989 +989 @@
     m->devType = aDeviceType;
 
-    LogFlowThisFunc(("m->locationFull='%s', m->format=%s, m->id={%RTuuid}\n",
+    LogFlowThisFunc(("m->strLocationFull='%s', m->strFormat=%s, m->id={%RTuuid}\n",
                      m->strLocationFull.raw(), m->strFormat.raw(), m->id.raw()));
 
@@ -1346 +1346 @@
     if (FAILED(autoCaller.rc())) return autoCaller.rc();
 
-    /* no need to lock, m->format is const */
+    /* no need to lock, m->strFormat is const */
     m->strFormat.cloneTo(aFormat);
+
+    return S_OK;
+}
+
+STDMETHODIMP Medium::COMGETTER(MediumFormat)(IMediumFormat **aMediumFormat)
+{
+    CheckComArgOutPointerValid(aMediumFormat);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    /* no need to lock, m->formatObj is const */
+    m->formatObj.queryInterfaceTo(aMediumFormat);
 
     return S_OK;
@@ -2578 +2591 @@
 
 /**
- * Internal method to return the medium's format. Must have caller + locking!
+ * Internal method to return the medium's format string. Must have caller + locking!
  * @return
  */
@@ -2584 +2597 @@
 {
     return m->strFormat;
+}
+
+/**
+ * Internal method to return the medium's format object. Must have caller + locking!
+ * @return
+ */
+const ComObjPtr<MediumFormat> & Medium::getMediumFormat() const
+{
+    return m->formatObj;
 }
 
@@ -3159 +3181 @@
     AssertComRCReturn(autoCaller.rc(), strFormat);
 
-    /* m->format is const, no need to lock */
+    /* m->strFormat is const, no need to lock */
     strFormat = m->strFormat;
 

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

@@ -9358 +9358 @@
   <interface
     name="IMedium" extends="$unknown"
-    uuid="d709160c-303f-4ead-b7ef-53ffa26aa861"
+    uuid="1d578f43-5ef1-4415-b556-7592d3ccdc8f"
     wsmap="managed"
   >
@@ -9820 +9820 @@
         installation can be obtained using
         <link to="ISystemProperties::mediumFormats"/>.
+      </desc>
+    </attribute>
+
+    <attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
+      <desc>
+        Storage medium format object corresponding to this medium.
+
+        The value of this attribute is a reference to the medium format object
+        that specifies the backend properties used to store medium data. The
+        storage format is defined when you create a new medium or automatically
+        detected when you open an existing medium, and cannot be changed later.
+
+        <note>@c null is returned if there is no associated medium format
+        object. This can e.g. happen for medium objects representing host
+        drives and other special medium objects.</note>
       </desc>
     </attribute>

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

@@ -25 +25 @@
 
 class Progress;
+class MediumFormat;
 
 namespace settings
@@ -105 +106 @@
     STDMETHOD(COMGETTER(Size))(ULONG64 *aSize);
     STDMETHOD(COMGETTER(Format))(BSTR *aFormat);
+    STDMETHOD(COMGETTER(MediumFormat))(IMediumFormat **aMediumFormat);
     STDMETHOD(COMGETTER(Type))(MediumType_T *aType);
     STDMETHOD(COMSETTER(Type))(MediumType_T aType);
@@ -158 +160 @@
     const Utf8Str& getLocationFull() const;
     const Utf8Str& getFormat() const;
+    const ComObjPtr<MediumFormat> & getMediumFormat() const;
     uint64_t getSize() const;
     MediumType_T getType() const;