Changeset 12810 in vbox for trunk/src

Timestamp:

Sep 29, 2008 4:11:14 PM (17 years ago)

Author:

vboxsync

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

37164

Message:

VbglR3GuestPropDelTree -> VbglR3GuestPropDelSet, documenting it and adjusting the interface to be easier to use (const strings).

Location:

trunk/src/VBox/Additions

Files:

• WINNT/VBoxService/VBoxVMInfo.cpp (modified) (1 diff)
• common/VBoxGuestLib/VBoxGuestR3LibGuestProp.cpp (modified) (4 diffs)

trunk/src/VBox/Additions/WINNT/VBoxService/VBoxVMInfo.cpp

@@ -112 +112 @@
     Assert(pCtx);
 
-    /* @todo Temporary solution: Zap all values which are not valid anymore when VM goes down (reboot/shutdown).
+    /** @todo Temporary solution: Zap all values which are not valid anymore when VM goes down (reboot/shutdown).
      * Needs to be replaced with "temporary properties" later. */
-    char szPropPath [_MAX_PATH+1] = {0};
-    char*pPtr = &szPropPath[0];
 
     vboxVMInfoWriteProp(pCtx, "GuestInfo/OS/LoggedInUsersList", "");
     vboxVMInfoWritePropInt(pCtx, "GuestInfo/OS/LoggedInUsers", 0);
 
-    RTStrPrintf(szPropPath, sizeof(szPropPath), "/VirtualBox/GuestInfo/Net/*");
-    VbglR3GuestPropDelTree(pCtx->iInfoSvcClientID, &pPtr, 1);
+    const char *apszPat[1] = { "/VirtualBox/GuestInfo/Net/*" };
+    VbglR3GuestPropDelSet(pCtx->iInfoSvcClientID, &apszPat[0], RT_ELEMENTS(apszPat));
     vboxVMInfoWritePropInt(pCtx, "GuestInfo/Net/Count", 0);
 

trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestProp.cpp

@@ -508 +508 @@
  *          uninitialised
  *
- * @param   papszPatterns The patterns against which the properties are
- *                        matched.  Pass NULL if everything should be matched.
- * @param   cPatterns     The number of patterns in @a papszPatterns.  0 means
- *                        match everything.
- * @param   ppHandle      where the handle for continued enumeration is stored
- *                        on success.  This must be freed with
- *                        VbglR3GuestPropEnumFree when it is no longer needed.
- * @param   ppszName      Where to store the first property name on success.
- *                        Should not be freed.
- * @param   ppszValue     Where to store the first property value on success.
- *                        Should not be freed.
- * @param   ppszValue     Where to store the first timestamp value on success.
- * @param   ppszFlags     Where to store the first flags value on success.
- *                        Should not be freed.
+ * @param   u32ClientId     The client id returned by VbglR3InfoSvcConnect().
+ * @param   papszPatterns   The patterns against which the properties are
+ *                          matched.  Pass NULL if everything should be matched.
+ * @param   cPatterns       The number of patterns in @a papszPatterns.  0 means
+ *                          match everything.
+ * @param   ppHandle        where the handle for continued enumeration is stored
+ *                          on success.  This must be freed with
+ *                          VbglR3GuestPropEnumFree when it is no longer needed.
+ * @param   ppszName        Where to store the first property name on success.
+ *                          Should not be freed.
+ * @param   ppszValue       Where to store the first property value on success.
+ *                          Should not be freed.
+ * @param   ppszValue       Where to store the first timestamp value on success.
+ * @param   ppszFlags       Where to store the first flags value on success.
+ *                          Should not be freed.
+ *
+ * @todo    Make papszPatterns char const * const *, and cPatterns size_t (so we
+ *          can use RT_ELEMENTS without getting warnings on Windows).
+ *          Most of the returns should also be made char const * to discourage
+ *          changes and encourage compiler optimizations.
  */
 VBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId,
@@ -613 +619 @@
  *                       set to NULL if there are no more properties to
  *                       enumerate.  This pointer should not be freed.
+ *
+ * @todo return char const *.
  */
 VBGLR3DECL(int) VbglR3GuestPropEnumNext(PVBGLR3GUESTPROPENUM pHandle,
@@ -652 +660 @@
 }
 
-/**
- * Deletes a key (matching pattern) including its children.
- *
- * @returns VBox status code.
- */
-VBGLR3DECL(int) VbglR3GuestPropDelTree(uint32_t u32ClientId,
-                                       char **papszPatterns,
-                                       int cPatterns)
-{
-    PVBGLR3GUESTPROPENUM pHandle = NULL;
-    int rc = VINF_SUCCESS;
-
-    char* pszName = NULL;
-    char* pszValue = NULL;
-    uint64_t pu64Timestamp = 0;
-    char* pszFlags = NULL;
-
-    rc = VbglR3GuestPropEnum(u32ClientId,
-                             papszPatterns,
-                             cPatterns,
-                             &pHandle,
-                             &pszName,
-                             &pszValue,
-                             &pu64Timestamp,
-                             &pszFlags);
-
-    while (RT_SUCCESS(rc) && (pszName != NULL))
+
+/**
+ * Deletes a set of keys.
+ *
+ * The set is specified in the same way as for VbglR3GuestPropEnum.
+ *
+ * @returns VBox status code. Stops on first failure.
+ *          See also VbglR3GuestPropEnum.
+ *
+ * @param   u32ClientId     The client id returned by VbglR3InfoSvcConnect().
+ * @param   papszPatterns   The patterns against which the properties are
+ *                          matched.  Pass NULL if everything should be matched.
+ * @param   cPatterns       The number of patterns in @a papszPatterns.  0 means
+ *                          match everything.
+ */
+VBGLR3DECL(int) VbglR3GuestPropDelSet(uint32_t u32ClientId,
+                                      const char * const *papszPatterns,
+                                      size_t cPatterns)
+{
+    PVBGLR3GUESTPROPENUM pHandle;
+    char *pszName;
+    char *pszValue;
+    uint64_t pu64Timestamp;
+    char *pszFlags;
+    int rc = VbglR3GuestPropEnum(u32ClientId,
+                                 (char **)papszPatterns, /** @todo fix this cast. */
+                                 cPatterns,
+                                 &pHandle,
+                                 &pszName,
+                                 &pszValue,
+                                 &pu64Timestamp,
+                                 &pszFlags);
+
+    while (RT_SUCCESS(rc) && pszName)
     {
         rc = VbglR3GuestPropWriteValue(u32ClientId, pszName, NULL);
-        if(!RT_SUCCESS(rc))
+        if (!RT_SUCCESS(rc))
             break;
 
@@ -694 +709 @@
     return rc;
 }
+