Changeset 27246 in vbox for trunk/include/iprt

Timestamp:

Mar 10, 2010 12:51:15 PM (15 years ago)

Author:

vboxsync

Message:

RTDirRemoveRecursive: Fixed memory leak, made it deal with UNKNOWN and thus work on Linux, optimized stack usage, added flag for only removing the content of the specified directory. TXS: clean up the scratch directory.

File:

• trunk/include/iprt/dir.h (modified) (3 diffs)

trunk/include/iprt/dir.h

@@ -103 +103 @@
  *
  * @returns iprt status code.
- * @param   pszPath   Path to the directory to remove.
+ * @param   pszPath         Path to the directory to remove.
  */
 RTDECL(int) RTDirRemove(const char *pszPath);
@@ -111 +111 @@
  *
  * @returns iprt status code.
- * @param   pszPath   Path to the directory to remove recursively.
- */
-RTDECL(int) RTDirRemoveRecursive(const char *pszPath);
+ * @param   pszPath         Path to the directory to remove recursively.
+ * @param   fFlags          Flags, see RTDIRRMREC_F_XXX.
+ */
+RTDECL(int) RTDirRemoveRecursive(const char *pszPath, uint32_t fFlags);
+
+/** @name   RTDirRemoveRecursive flags.
+ * @{ */
+/** Only delete the content of the directory, omit the directory it self. */
+#define RTDIRRMREC_F_CONTENT_ONLY   RT_BIT_32(0)
+/** Mask of valid flags. */
+#define RTDIRRMREC_F_VALID_MASK     UINT32_C(0x00000001)
+/** @} */
 
 
@@ -184 +193 @@
 {
     /** The unique identifier (within the file system) of this file system object (d_ino).
+     *
      * Together with INodeIdDevice, this field can be used as a OS wide unique id
-     * when both their values are not 0.
-     * This field is 0 if the information is not available. */
+     * when both their values are not 0.  This field is 0 if the information is not
+     * available. */
     RTINODE         INodeId;
     /** The entry type. (d_type)
-     * RTDIRENTRYTYPE_UNKNOWN is a legal return value here and
-     * should be expected by the user. */
+     * RTDIRENTRYTYPE_UNKNOWN is a common return value here since not all file
+     * systems (or Unixes) stores the type of a directory entry and instead
+     * expects the user to use stat() to get it.  So, when you see this you
+     * should use RTPathQueryInfo to get the type, or if if you're lazy, use
+     * RTDirReadEx. */
     RTDIRENTRYTYPE  enmType;
-    /** The length of the filename. */
+    /** The length of the filename, excluding the terminating nul character. */
     uint16_t        cbName;
     /** The filename. (no path)