Changeset 25005 in vbox for trunk/include/iprt

Timestamp:

Nov 26, 2009 2:42:59 PM (15 years ago)

Author:

vboxsync

Message:

IPRT: Optimized version of RTStrVersionCompare (thanks to Knut!), made it behave like strcmp().

File:

• trunk/include/iprt/string.h (modified) (1 diff)

trunk/include/iprt/string.h

@@ -1063 +1063 @@
  * will be skipped, so "12.foo006" becomes "12.6".
  *
- * @returns iprt status code.
- *          Warnings are used to indicate convertion problems.
- * @retval  VWRN_NUMBER_TOO_BIG
- * @retval  VWRN_TRAILING_CHARS
- * @retval  VWRN_TRAILING_SPACES
- * @retval  VINF_SUCCESS
- * @retval  VERR_NO_MEMORY
- * @retval  VERR_NO_DIGITS
+ * @returns integer value indicating the relationship between the versions:
+ * @retval  0, if both versions are equal.
+ * @retval  1, if pszVer1 is greater.
+ * @retval  2, if pszVer2 is greater.
  *
  * @param   pszVer1     First version string to compare.
- * @param   pszVer2     First version string to compare.
- * @param   pui8Res     Pointer uint8_t value where to store the comparison result:
- *                      0 if equal, 1 if pszVer1 is greater, 2 if pszVer2 is greater.
- */
-RTDECL(int) RTStrVersionCompare(const char *pszVer1, const char *pszVer2, uint8_t *pui8Res);
+ * @param   pszVer2     Second version string to compare first version with.
+ */
+RTDECL(int) RTStrVersionCompare(const char *pszVer1, const char *pszVer2);
 
 /**