Changeset 52308 in vbox

Timestamp:

Aug 6, 2014 6:47:47 PM (10 years ago)

Author:

vboxsync

Message:

Additions/common/VBoxGuestLib: change VbglR3GuestPropEnum() to return success if no properties are found.

File:

• trunk/src/VBox/Additions/common/VBoxGuestLib/VBoxGuestR3LibGuestProp.cpp (modified) (3 diffs)

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

@@ -581 +581 @@
  *          the enumeration and *ppszName, *ppszValue, *pu64Timestamp and
  *          *ppszFlags are set.
- * @retval  VERR_NOT_FOUND if no matching properties were found.  In this case
- *          the return parameters are not initialised.
  * @retval  VERR_TOO_MUCH_DATA if it was not possible to determine the amount
  *          of local space needed to store all the enumeration data.  This is
@@ -597 +595 @@
  *                          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. Optional.
- * @param   ppszValue       Where to store the first property value on success.
- *                          Should not be freed. Optional.
- * @param   ppszValue       Where to store the first timestamp value on success.
- *                          Optional.
- * @param   ppszFlags       Where to store the first flags value on success.
- *                          Should not be freed. Optional.
+ * @param  ppszName      Where to store the next property name.  This will be
+ *                       set to NULL if there are no more properties to
+ *                       enumerate.  This pointer should not be freed. Optional.
+ * @param  ppszValue     Where to store the next property value.  This will be
+ *                       set to NULL if there are no more properties to
+ *                       enumerate.  This pointer should not be freed. Optional.
+ * @param  pu64Timestamp Where to store the next property timestamp.  This
+ *                       will be set to zero if there are no more properties
+ *                       to enumerate. Optional.
+ * @param  ppszFlags     Where to store the next property flags.  This will be
+ *                       set to NULL if there are no more properties to
+ *                       enumerate.  This pointer should not be freed. Optional.
+ *
+ * @remarks While all output parameters are optional, you need at least one to
+ *          figure out when to stop.
  */
 VBGLR3DECL(int) VbglR3GuestPropEnum(uint32_t u32ClientId,
@@ -673 +678 @@
         rc = VbglR3GuestPropEnumNext(Handle.get(), ppszName, ppszValue,
                                      pu64Timestamp, ppszFlags);
-        if (RT_SUCCESS(rc) && *ppszName != NULL)
+        if (RT_SUCCESS(rc))
             *ppHandle = Handle.release();
-        else if (RT_SUCCESS(rc))
-            rc = VERR_NOT_FOUND; /* No matching properties found. */
     }
     else if (rc == VERR_BUFFER_OVERFLOW)