Changeset 44322 in vbox

Timestamp:

Jan 21, 2013 2:36:11 PM (12 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

83256

Message:

Fe/VBoxManage: Implemented "guestproperty delete", updated documentation.

Location:

trunk

Files:

• doc/manual/en_US/user_VBoxManage.xml (modified) (4 diffs)
• src/VBox/Frontends/VBoxManage/VBoxManageGuestProp.cpp (modified) (5 diffs)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (3 diffs)

trunk/doc/manual/en_US/user_VBoxManage.xml

@@ -695 +695 @@
           <listitem>
             <para><computeroutput>--lptmode&lt;1-N&gt;
-            &lt;Device&gt;</computeroutput> 
-            Specifies the Device Name of the parallel port that 
+            &lt;Device&gt;</computeroutput>
+            Specifies the Device Name of the parallel port that
             the Parallel Port feature will be using. Use this
             <emphasis>before</emphasis> <computeroutput>--lpt</computeroutput>.
@@ -704 +704 @@
           <listitem>
             <para><computeroutput>--lpt&lt;1-N&gt;
-            &lt;I/O base&gt; &lt;IRQ&gt;</computeroutput> 
+            &lt;I/O base&gt; &lt;IRQ&gt;</computeroutput>
             Specifies the I/O address of the parallel port and the IRQ
             number that the Parallel Port feature will be using. Use this
             <emphasis>after</emphasis>
-            <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are 
+            <computeroutput>--lptmod</computeroutput>. I/O base address and IRQ are
                         the values that guest sees i.e. the values avalable under guest Device Manager.</para>
           </listitem>
@@ -1743 +1743 @@
                     image to the given device slot.</para>
                 </listitem>
-              
+
                 <listitem>
                   <para>If a UUID is specified, it must be the UUID of a
@@ -2644 +2644 @@
           above.</para>
         </listitem>
+
+        <listitem>
+          <para><computeroutput>delete &lt;vm&gt; &lt;property&gt;
+          </computeroutput>: Deletes a formerly set guest property.
+          </para></listitem>
       </itemizedlist></para>
   </sect1>

trunk/src/VBox/Frontends/VBoxManage/VBoxManageGuestProp.cpp

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -62 +62 @@
                        "%s guestproperty %s   set <vmname>|<uuid>\n"
                  "                            <property> [<value> [--flags <flags>]]\n"
+                 "\n", pcszSep1, pcszSep2);
+    RTStrmPrintf(pStrm,
+                       "%s guestproperty %s   delete <vmname>|<uuid>\n"
+                 "                            <property>\n"
                  "\n", pcszSep1, pcszSep2);
     RTStrmPrintf(pStrm,
@@ -159 +163 @@
         a->session->COMGETTER(Machine)(machine.asOutParam());
 
-        if (!pszValue && !pszFlags)
-            CHECK_ERROR(machine, DeleteGuestProperty(Bstr(pszName).raw()));
-        else if (!pszFlags)
+        if (!pszFlags)
             CHECK_ERROR(machine, SetGuestPropertyValue(Bstr(pszName).raw(),
                                                        Bstr(pszValue).raw()));
@@ -168 +170 @@
                                                   Bstr(pszValue).raw(),
                                                   Bstr(pszFlags).raw()));
+
+        if (SUCCEEDED(rc))
+            CHECK_ERROR(machine, SaveSettings());
+
+        a->session->UnlockMachine();
+    }
+    return SUCCEEDED(rc) ? 0 : 1;
+}
+
+static int handleDeleteGuestProperty(HandlerArg *a)
+{
+    HRESULT rc = S_OK;
+
+    /*
+     * Check the syntax.  We can deduce the correct syntax from the number of
+     * arguments.
+     */
+    bool usageOK = true;
+    const char *pszName = NULL;
+    if (a->argc != 2)
+        usageOK = false;
+    if (!usageOK)
+        return errorSyntax(USAGE_GUESTPROPERTY, "Incorrect parameters");
+    /* This is always needed. */
+    pszName = a->argv[1];
+
+    ComPtr<IMachine> machine;
+    CHECK_ERROR(a->virtualBox, FindMachine(Bstr(a->argv[0]).raw(),
+                                           machine.asOutParam()));
+    if (machine)
+    {
+        /* open a session for the VM - new or existing */
+        CHECK_ERROR_RET(machine, LockMachine(a->session, LockType_Shared), 1);
+
+        /* get the mutable session machine */
+        a->session->COMGETTER(Machine)(machine.asOutParam());
+
+        CHECK_ERROR(machine, DeleteGuestProperty(Bstr(pszName).raw()));
 
         if (SUCCEEDED(rc))
@@ -385 +425 @@
     if (strcmp(a->argv[0], "set") == 0)
         return handleSetGuestProperty(&arg);
+    if (strcmp(a->argv[0], "delete") == 0)
+        return handleDeleteGuestProperty(&arg);
     if (strcmp(a->argv[0], "enumerate") == 0)
         return handleEnumGuestProperty(&arg);

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

@@ -3 +3 @@
 <!--
 
-    Copyright (C) 2006-2012 Oracle Corporation
+    Copyright (C) 2006-2013 Oracle Corporation
 
     This file is part of VirtualBox Open Source Edition (OSE), as
@@ -6293 +6293 @@
     <method name="setGuestPropertyValue">
       <desc>
-        Sets, changes or deletes a value in the machine's guest property
+        Sets or changes a value in the machine's guest property
         store.  The flags field will be left unchanged or created empty for a
         new property.
@@ -6310 +6310 @@
       <param name="property" type="wstring" dir="in">
         <desc>
-          The name of the property to set, change or delete.
+          The name of the property to set or change.
         </desc>
       </param>
       <param name="value" type="wstring" dir="in">
         <desc>
-          The new value of the property to set, change or delete.  If the
+          The new value of the property to set or change. If the
           property does not yet exist and value is non-empty, it will be
-          created.  If the value is @c null or empty, the property will be
-          deleted if it exists.
+          created.
         </desc>
       </param>