Changeset 16248 in vbox

Timestamp:

Jan 26, 2009 9:11:36 PM (16 years ago)

Author:

vboxsync

Message:

OVF: turn IAppliance::getDisks into real attribute, code cleanup, preliminary API documentation.

Location:

trunk/src/VBox/Main

Files:

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

trunk/src/VBox/Main/ApplianceImpl.cpp

@@ -74 +74 @@
     uint32_t ulParent;
 
-    string strHostResource;
     OVFResourceType_T resourceType;
     string strOtherResourceType;
     string strResourceSubType;
+
+    string strHostResource;             // "Abstractly specifies how a device shall connect to a resource on the deployment platform.
+                                        // Not all devices need a backing." Used with disk items, for which this references a virtual
+                                        // disk from the Disks section.
     bool fAutomaticAllocation;
     bool fAutomaticDeallocation;
-    string strConnection;           // for ethernet
-    string strAddress;
-    string strAddressOnParent;
-    string strAllocationUnits;
-    uint64_t ullVirtualQuantity;
-    uint64_t ullReservation;
-    uint64_t ullLimit;
-    uint64_t ullWeight;
+    string strConnection;               // "All Ethernet adapters that specify the same abstract network connection name within an OVF
+                                        // package shall be deployed on the same network. The abstract network connection name shall be
+                                        // listed in the NetworkSection at the outermost envelope level."
+    string strAddress;                  // "Device-specific. For an Ethernet adapter, this specifies the MAC address."
+    string strAddressOnParent;          // "For a device, this specifies its location on the controller."
+    string strAllocationUnits;          // "Specifies the units of allocation used. For example, “byte * 2^20”."
+    uint64_t ullVirtualQuantity;        // "Specifies the quantity of resources presented. For example, “256”."
+    uint64_t ullReservation;            // "Specifies the minimum quantity of resources guaranteed to be available."
+    uint64_t ullLimit;                  // "Specifies the maximum quantity of resources that will be granted."
+    uint64_t ullWeight;                 // "Specifies a relative priority for this allocation in relation to other allocations."
+
     string strConsumerVisibility;
     string strMappingBehavior;
     string strPoolID;
-    uint32_t ulBusNumber;
-
-    uint32_t ulLineNumber;          // line number of <Item> element in XML source
+    uint32_t ulBusNumber;               // seen with IDE controllers, but not listed in OVF spec
+
+    uint32_t ulLineNumber;              // line number of <Item> element in XML source; cached for error messages
 
     VirtualHardwareItem()
-        : ulInstanceID(0), fAutomaticAllocation(false), fAutomaticDeallocation(false), ullVirtualQuantity(0), ullReservation(0), ullLimit(0), ullWeight(0)
+        : ulInstanceID(0), fAutomaticAllocation(false), fAutomaticDeallocation(false), ullVirtualQuantity(0), ullReservation(0), ullLimit(0), ullWeight(0), ulBusNumber(0), ulLineNumber(0)
     {};
 };
@@ -835 +841 @@
 }
 
-STDMETHODIMP Appliance::GetDisks(ComSafeArrayOut(BSTR, aDisks), ULONG *cDisks)
+STDMETHODIMP Appliance::COMGETTER(Disks)(ComSafeArrayOut(BSTR, aDisks))
 {
     CheckComArgOutSafeArrayPointerValid(aDisks);
@@ -880 +886 @@
     }
 
-    *cDisks = (ULONG)i;
-
     sfaDisks.detachTo(ComSafeArrayOutArg(aDisks));
 
@@ -898 +902 @@
     SafeIfaceArray<IVirtualSystemDescription> sfaVSD(m->virtualSystemDescriptions);
     sfaVSD.detachTo(ComSafeArrayOutArg(aVirtualSystemDescriptions));
-
-    return S_OK;
-}
-
-STDMETHODIMP Appliance::ImportAppliance()
-{
-    HRESULT rc = S_OK;
-
-    list<VirtualSystem>::const_iterator it;
-    list< ComObjPtr<VirtualSystemDescription> >::const_iterator it1;
-    /* Iterate through all appliances */
-    size_t i = 0;
-    for (it = m->llVirtualSystems.begin(),
-         it1 = m->virtualSystemDescriptions.begin();
-         it != m->llVirtualSystems.end();
-         ++it, ++it1, ++i)
-    {
-        const VirtualSystem &vs = *it;
-        ComObjPtr<VirtualSystemDescription> vsd = (*it1);
-
-        /* Guest OS type */
-        list<VirtualSystemDescriptionEntry> vsdeOS = vsd->findByType(VirtualSystemDescriptionType_OS);
-        Assert(vsdeOS.size() == 1);
-        string osTypeVBox = vsdeOS.front().strFinalValue;
-
-        /* Now that we know the base system get our internal defaults based on that. */
-        IGuestOSType *osType = NULL;
-        rc = mVirtualBox->GetGuestOSType(Bstr(Utf8Str(osTypeVBox.c_str())), &osType);
-        ComAssertComRCThrowRC(rc);
-
-        /* Create the machine */
-        /* First get the name */
-        list<VirtualSystemDescriptionEntry> vsdeName = vsd->findByType(VirtualSystemDescriptionType_Name);
-        Assert(vsdeName.size() == 1);
-        string nameVBox = vsdeName.front().strFinalValue;
-        IMachine *newMachine = NULL;
-        rc = mVirtualBox->CreateMachine(Bstr(nameVBox.c_str()), Bstr(osTypeVBox.c_str()),
-                                        Bstr(), Guid(),
-                                        &newMachine);
-        ComAssertComRCThrowRC(rc);
-
-        /* CPU count (ignored for now) */
-        /* @todo: check min/max requirements of VBox (SchemaDefs::Min/MaxCPUCount) */
-        // list<VirtualSystemDescriptionEntry> vsdeCPU = vsd->findByType (VirtualSystemDescriptionType_CPU);
-
-        /* RAM */
-        /* @todo: check min/max requirements of VBox (SchemaDefs::Min/MaxGuestRAM) */
-        list<VirtualSystemDescriptionEntry> vsdeRAM = vsd->findByType(VirtualSystemDescriptionType_Memory);
-        Assert(vsdeRAM.size() == 1);
-        string memoryVBox = vsdeRAM.front().strFinalValue;
-        uint64_t tt = RTStrToUInt64(memoryVBox.c_str()) / _1M;
-
-        rc = newMachine->COMSETTER(MemorySize)(tt);
-        ComAssertComRCThrowRC(rc);
-
-        /* VRAM */
-        /* Get the recommended VRAM for this guest OS type */
-        /* @todo: check min/max requirements of VBox (SchemaDefs::Min/MaxGuestVRAM) */
-        ULONG vramVBox;
-        rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);
-        ComAssertComRCThrowRC(rc);
-        /* Set the VRAM */
-        rc = newMachine->COMSETTER(VRAMSize)(vramVBox);
-        ComAssertComRCThrowRC(rc);
-
-        /* Change the network adapters */
-        list<VirtualSystemDescriptionEntry> vsdeNW = vsd->findByType(VirtualSystemDescriptionType_NetworkAdapter);
-        if (vsdeNW.size() == 0)
-        {
-            /* No network adapters, so we have to disable our default one */
-            INetworkAdapter *nwVBox = NULL;
-            rc = newMachine->GetNetworkAdapter(0, &nwVBox);
-            ComAssertComRCThrowRC(rc);
-            rc = nwVBox->COMSETTER(Enabled)(false);
-            ComAssertComRCThrowRC(rc);
-        }
-        else
-        {
-            list<VirtualSystemDescriptionEntry>::const_iterator nwIt;
-            /* Iterate through all network cards. We support 8 network adapters
-             * at the maximum. (@todo: warn if it are more!) */
-            size_t a = 0;
-            for (nwIt = vsdeNW.begin();
-                 (nwIt != vsdeNW.end() && a < SchemaDefs::NetworkAdapterCount);
-                 ++nwIt, ++a)
-            {
-                string nwTypeVBox = nwIt->strFinalValue;
-                uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
-                INetworkAdapter *nwVBox = NULL;
-                rc = newMachine->GetNetworkAdapter((ULONG)a, &nwVBox);
-                ComAssertComRCThrowRC(rc);
-                /* Enable the network card & set the adapter type */
-                /* NAT is set as default */
-                rc = nwVBox->COMSETTER(Enabled)(true);
-                ComAssertComRCThrowRC(rc);
-                rc = nwVBox->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));
-                ComAssertComRCThrowRC(rc);
-            }
-        }
-        /* Now its time to register the machine before we add any hard disks */
-        rc = mVirtualBox->RegisterMachine(newMachine);
-        ComAssertComRCThrowRC(rc);
-
-        /* @todo: Unregister on failure */
-#if 0
-        vbox.UnregisterMachine (machineId);
-        if (vbox.isOk())
-            mMachine.DeleteSettings();
-        return false;
-#endif
-    }
 
     return S_OK;
@@ -1372 +1265 @@
 }
 
+STDMETHODIMP Appliance::ImportAppliance()
+{
+    HRESULT rc = S_OK;
+
+    list<VirtualSystem>::const_iterator it;
+    list< ComObjPtr<VirtualSystemDescription> >::const_iterator it1;
+    /* Iterate through all appliances */
+    size_t i = 0;
+    for (it = m->llVirtualSystems.begin(),
+         it1 = m->virtualSystemDescriptions.begin();
+         it != m->llVirtualSystems.end();
+         ++it, ++it1, ++i)
+    {
+        const VirtualSystem &vs = *it;
+        ComObjPtr<VirtualSystemDescription> vsd = (*it1);
+
+        /* Guest OS type */
+        list<VirtualSystemDescriptionEntry> vsdeOS = vsd->findByType(VirtualSystemDescriptionType_OS);
+        Assert(vsdeOS.size() == 1);
+        string osTypeVBox = vsdeOS.front().strFinalValue;
+
+        /* Now that we know the base system get our internal defaults based on that. */
+        IGuestOSType *osType = NULL;
+        rc = mVirtualBox->GetGuestOSType(Bstr(Utf8Str(osTypeVBox.c_str())), &osType);
+        ComAssertComRCThrowRC(rc);
+
+        /* Create the machine */
+        /* First get the name */
+        list<VirtualSystemDescriptionEntry> vsdeName = vsd->findByType(VirtualSystemDescriptionType_Name);
+        Assert(vsdeName.size() == 1);
+        string nameVBox = vsdeName.front().strFinalValue;
+        IMachine *newMachine = NULL;
+        rc = mVirtualBox->CreateMachine(Bstr(nameVBox.c_str()), Bstr(osTypeVBox.c_str()),
+                                        Bstr(), Guid(),
+                                        &newMachine);
+        ComAssertComRCThrowRC(rc);
+
+        /* CPU count (ignored for now) */
+        /* @todo: check min/max requirements of VBox (SchemaDefs::Min/MaxCPUCount) */
+        // list<VirtualSystemDescriptionEntry> vsdeCPU = vsd->findByType (VirtualSystemDescriptionType_CPU);
+
+        /* RAM */
+        /* @todo: check min/max requirements of VBox (SchemaDefs::Min/MaxGuestRAM) */
+        list<VirtualSystemDescriptionEntry> vsdeRAM = vsd->findByType(VirtualSystemDescriptionType_Memory);
+        Assert(vsdeRAM.size() == 1);
+        string memoryVBox = vsdeRAM.front().strFinalValue;
+        uint64_t tt = RTStrToUInt64(memoryVBox.c_str()) / _1M;
+
+        rc = newMachine->COMSETTER(MemorySize)(tt);
+        ComAssertComRCThrowRC(rc);
+
+        /* VRAM */
+        /* Get the recommended VRAM for this guest OS type */
+        /* @todo: check min/max requirements of VBox (SchemaDefs::Min/MaxGuestVRAM) */
+        ULONG vramVBox;
+        rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);
+        ComAssertComRCThrowRC(rc);
+        /* Set the VRAM */
+        rc = newMachine->COMSETTER(VRAMSize)(vramVBox);
+        ComAssertComRCThrowRC(rc);
+
+        /* Change the network adapters */
+        list<VirtualSystemDescriptionEntry> vsdeNW = vsd->findByType(VirtualSystemDescriptionType_NetworkAdapter);
+        if (vsdeNW.size() == 0)
+        {
+            /* No network adapters, so we have to disable our default one */
+            INetworkAdapter *nwVBox = NULL;
+            rc = newMachine->GetNetworkAdapter(0, &nwVBox);
+            ComAssertComRCThrowRC(rc);
+            rc = nwVBox->COMSETTER(Enabled)(false);
+            ComAssertComRCThrowRC(rc);
+        }
+        else
+        {
+            list<VirtualSystemDescriptionEntry>::const_iterator nwIt;
+            /* Iterate through all network cards. We support 8 network adapters
+             * at the maximum. (@todo: warn if it are more!) */
+            size_t a = 0;
+            for (nwIt = vsdeNW.begin();
+                 (nwIt != vsdeNW.end() && a < SchemaDefs::NetworkAdapterCount);
+                 ++nwIt, ++a)
+            {
+                string nwTypeVBox = nwIt->strFinalValue;
+                uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
+                INetworkAdapter *nwVBox = NULL;
+                rc = newMachine->GetNetworkAdapter((ULONG)a, &nwVBox);
+                ComAssertComRCThrowRC(rc);
+                /* Enable the network card & set the adapter type */
+                /* NAT is set as default */
+                rc = nwVBox->COMSETTER(Enabled)(true);
+                ComAssertComRCThrowRC(rc);
+                rc = nwVBox->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));
+                ComAssertComRCThrowRC(rc);
+            }
+        }
+        /* Now its time to register the machine before we add any hard disks */
+        rc = mVirtualBox->RegisterMachine(newMachine);
+        ComAssertComRCThrowRC(rc);
+
+        /* @todo: Unregister on failure */
+#if 0
+        vbox.UnregisterMachine (machineId);
+        if (vbox.isOk())
+            mMachine.DeleteSettings();
+        return false;
+#endif
+    }
+
+    return S_OK;
+}
+
 HRESULT Appliance::searchUniqueVMName(std::string& aName)
 {

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

@@ -2882 +2882 @@
         <link to="IVirtualBox::openAppliance" />.
 
-        Opening an appliance is a three-step process with VirtualBox: first
-        <link to="IVirtualBox::openAppliance" /> is called, which succeeds if the
-        appliance file is syntactically valid, irrespective of whether VirtualBox
-        can handle the appliance.
-
-        As a second step, the caller should then invoke <link to="IAppliance::interpret" />,
-        which analyzes the OVF data and sets up the contents of the IAppliance attributes
-        accordingly. These can be inspected by a VirtualBox front-end such as the GUI,
-        and the suggestions can be displayed to the user. For example, the virtual system
-        will contain the virtual hardware prescribed by the OVF (network and hardware
-        adapters, virtual disk images, memory size and so on), and the GUI can then give
-        the user the option to confirm and/or change these suggestions.
-
-        As a third step, the caller should invoke <link to="#Import" />, which will create
-        virtual machines in VirtualBox as instances of <link to="IMachine" /> that match the
-        information in the virtual system descriptions.
+        Importing an OVF appliance into VirtualBox is a three-step process:
+
+        <ol>
+          <li>
+          Call <link to="IVirtualBox::openAppliance" /> with the full path of the OVF
+          file. So long as the appliance file is syntactically valid, this will succeed
+          and return an instance of IAppliance that contains the parsed data from the
+          OVF file.
+          </li>
+
+          <li>The caller should then invoke <link to="#interpret" />, which
+          analyzes the OVF data and sets up the contents of the IAppliance attributes
+          accordingly. These can be inspected by a VirtualBox front-end such as the GUI,
+          and the suggestions can be displayed to the user. For example, the virtual system
+          will contain the virtual hardware prescribed by the OVF (network and hardware
+          adapters, virtual disk images, memory size and so on), and the GUI can then give
+          the user the option to confirm and/or change these suggestions.
+          </li>
+
+          <li>Finally, the caller should invoke <link to="#importAppliance" />, which will
+          create virtual machines in VirtualBox as instances of <link to="IMachine" /> that
+          match the information in the virtual system descriptions.
+          </li>
+        </ol>
+
     </desc>
 
@@ -2905 +2914 @@
     </attribute>
 
-    <attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
-      <desc>
-      Array of virtual system descriptions. One such description gets created by
-      <link to="#interpret" /> for each virtual system found in the OVF.
-      </desc>
-    </attribute>
-
-    <method name="interpret">
-      <desc>
-        Interprets the OVF data that was read when the appliance was constructed. After
-        calling this method, one can call
-        <link to="#getDisks" /> to retrieve disk information and also inspect the
-        <link to="#virtualSystemDescriptions" /> array attribute, which will then contain
-        one <link to="IVirtualSystemDescription" /> for each virtual machine found in
-        the appliance.
-      </desc>
-    </method>
-
-    <method name="getDisks">
-      <desc>
-        Returns disk information from the appliance specification in a string
-        array. Each array item represents one piece of disk information, with the
-        information fields separated by tab (\t) characters.
+    <attribute name="disks" type="wstring" readonly="yes" safearray="yes">
+      <desc>
+        Array of virtual disk definitions. One such description exists for each
+        disk definition in the OVF; each string array item represents one such piece of
+        disk information, with the information fields separated by tab (\t) characters.
 
         The caller should be prepared for additional fields being appended to
@@ -2952 +2943 @@
             <li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
         </ol>
-
-      </desc>
-
-      <param name="aDisks" type="wstring" dir="out" safearray="yes">
-        <desc>Array of strings to receive disk information.</desc>
-      </param>
-
-      <param name="cDisks" type="unsigned long" dir="return">
-        <desc>Count of array items returned in aDisks.</desc>
-      </param>
+      </desc>
+    </attribute>
+
+    <attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
+      <desc>
+      Array of virtual system descriptions. One such description is created
+      for each virtual system found in the OVF. The array is empty until after <link to="#interpret" />
+      has been called.
+      </desc>
+    </attribute>
+
+    <method name="interpret">
+      <desc>
+        Interprets the OVF data that was read when the appliance was constructed. After
+        calling this method, one can inspect the
+        <link to="#virtualSystemDescriptions" /> array attribute, which will then contain
+        one <link to="IVirtualSystemDescription" /> for each virtual machine found in
+        the appliance.
+
+        Calling this method is the second step of importing an appliance into VirtualBox;
+        see <link to="IAppliance" /> for an overview.
+      </desc>
     </method>
 
     <method name="importAppliance">
+      <desc>
+        Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
+        and other interfaces that match the information contained in the appliance as
+        closely as possible, as represented by the import instructions in the
+        <link to="#virtualSystemDescriptions" /> array.
+
+        Calling this method is the final step of importing an appliance into VirtualBox;
+        see <link to="IAppliance" /> for an overview.
+      </desc>
     </method>
 
@@ -2973 +2985 @@
     uuid="36209b5a-8f96-44de-a0af-1bb037cef324"
   >
-    <desc>
-    </desc>
+    <desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
+    a configuration value.</desc>
 
     <const name="Name" value="1" />
@@ -2994 +3006 @@
      >
 
+    <desc>This interface is used in the <link to="IAppliance::virtualSystemDescriptions" /> array.
+    After <link to="IAppliance::interpret" /> has been called, that array contains
+    information about how the virtual systems described in the OVF should best be imported into VirtualBox
+    virtual machines. See <link to="IAppliance" /> for the steps required to import an OVF
+    into VirtualBox.
+    </desc>
+
     <method name="getDescription">
-      <desc></desc>
+      <desc>Returns information about the virtual system as arrays of instruction items. In each array, the
+      items with the same indices correspond and jointly represent an import instruction for VirtualBox.
+
+      The list below identifies the value sets that are possible depending on the
+      <link to="VirtualSystemDescriptionType" /> enum value in the array item in aTypes[]. In each case,
+      the array item with the same index in aOrigValues[] will contain the original value as contained
+      in the OVF file, and the corresponding item in aAutoValues[] will contain a suggested value to
+      be used for VirtualBox. Items in the other arrays will be empty, unless specified otherwise below:
+
+      <ul>
+      <li>
+        "OS": then the corresponding item in aAutoValues[] contains the suggested guest operating system
+        for VirtualBox. The corresponding item in aOrigValues[] will contain a numerical value that
+        described the operating system in the OVF (see <link to="CIMOSType" />).
+      </li>
+      <li>
+        "Name": then the correponding item im aOrigValues[] will contain the suggested virtual machine name
+        from the OVF file, and aAutoValues[] will contain a suggestion for a unique VirtualBox
+        <link to="IMachine" /> name that does not exist yet.
+      </li>
+      <li>
+        "CPU": number of CPUs.
+      </li>
+      <li>
+        "Memory": amount of memory, in bytes.
+      </li>
+      <li>
+        "HarddiskControllerSCSI": a SCSI hard disk controller. Here the items in aOrigValues[] and aAutoValues[] will either be
+        "LsiLogic" or "BusLogic". The matching item in the aRefValue[] array will contain a numerical
+        index that other items of the "Harddisk" type can use to specify which hard disk controller
+        a virtual disk should be connected to.
+      </li>
+      <li>
+        "HarddiskControllerIDE": an IDE hard disk controller. This has no value in aOrigValues[] or aAutoValues[];
+        as with SCSI controllers, the matching item in the aRefValues[] array will contain a numerical
+        index that other items of the "Harddisk" type can use to specify which hard disk controller
+        a virtual disk should be connected to.
+      </li>
+      <li>
+        "Harddisk": a virtual hard disk, most probably as a reference to an image file. The array item
+        in aOrigValues[] will contain the file specification from the OVF file, whereas the item
+        in aAutoValues[] will contain the fully qualified path to the image, which VirtualBox has verified
+        to exist.
+        The item in the aRefValues[] array specifies the hard disk controller to connect to and has the
+        same value as another aRefValues[] array item of the types listed above.
+      </li>
+      <li>
+        "NetworkAdapter": a network adapter. (todo document)
+      </li>
+      </ul>
+
+      </desc>
 
       <param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">

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

@@ -65 +65 @@
     /* IAppliance properties */
     STDMETHOD(COMGETTER(Path))(BSTR *aPath);
-
-    STDMETHOD(COMGETTER(VirtualSystemDescriptions))(ComSafeArrayOut (IVirtualSystemDescription*, aVirtualSystemDescriptions));
+    STDMETHOD(COMGETTER(Disks))(ComSafeArrayOut(BSTR, aDisks));
+    STDMETHOD(COMGETTER(VirtualSystemDescriptions))(ComSafeArrayOut(IVirtualSystemDescription*, aVirtualSystemDescriptions));
 
     /* IAppliance methods */
     /* void interpret (); */
     STDMETHOD(Interpret)(void);
-
-    /* void getDisks (out unsigned long aDisksSize, [array, size_is (aDisksSize)] out wstring aDisks, [retval] out unsigned long cDisks); */
-    STDMETHOD(GetDisks)(ComSafeArrayOut(BSTR, aDisks), ULONG *cDisks);
 
     /* public methods only for internal purposes */
@@ -142 +139 @@
 
     /* IVirtualSystemDescription methods */
-    STDMETHOD(GetDescription) (ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),
-                               ComSafeArrayOut(ULONG, aRefs),
-                               ComSafeArrayOut(BSTR, aOrigValues),
-                               ComSafeArrayOut(BSTR, aAutoValues),
-                               ComSafeArrayOut(BSTR, aConfigurations));
-    STDMETHOD(SetFinalValues) (ComSafeArrayIn (IN_BSTR, aFinalValues));
+    STDMETHOD(GetDescription)(ComSafeArrayOut(VirtualSystemDescriptionType_T, aTypes),
+                              ComSafeArrayOut(ULONG, aRefs),
+                              ComSafeArrayOut(BSTR, aOrigValues),
+                              ComSafeArrayOut(BSTR, aAutoValues),
+                              ComSafeArrayOut(BSTR, aConfigurations));
+    STDMETHOD(SetFinalValues)(ComSafeArrayIn(IN_BSTR, aFinalValues));
 
     /* public methods only for internal purposes */