Changeset 19928 in vbox for trunk/include

Timestamp:

May 22, 2009 11:47:35 PM (16 years ago)

Author:

vboxsync

Message:

IPRT: More RTPathAppend docs updates.

File:

• trunk/include/iprt/path.h (modified) (2 diffs)

trunk/include/iprt/path.h

@@ -349 +349 @@
  * concatenating the two partial paths.
  *
- * @returns IPRT status code.
- * @retval  VERR_PATH
+ * @retval  VINF_SUCCESS on success.
+ * @retval  VERR_BUFFER_OVERFLOW if the result is too big to fit within
+ *          cbPathDst bytes. No changes has been made.
+ * @retval  VERR_INVALID_PARAMETER if the string pointed to by pszPath is longer
+ *          than cbPathDst-1 bytes (failed to find terminator). Asserted.
  *
  * @param   pszPath         The path to append pszAppend to. This serves as both
  *                          input and output. This can be empty, in which case
  *                          pszAppend is just copied over.
- * @param   cchPathDst      The size of the buffer pszPath points to. This
- *                          should NOT be strlen(pszPath).
+ * @param   cbPathDst       The size of the buffer pszPath points to, terminator
+ *                          included. This should NOT be strlen(pszPath).
  * @param   pszAppend       The partial path to append to pszPath. This can be
  *                          NULL, in which case nothing is done.
@@ -371 +374 @@
  *          sizeof(szBuf), "bar") will result in "C:bar".
  */
-RTDECL(int) RTPathAppend(char *pszPath, size_t cchPathDst, const char *pszAppend);
+RTDECL(int) RTPathAppend(char *pszPath, size_t cbPathDst, const char *pszAppend);