Changeset 20105 in vbox for trunk/include/iprt

Timestamp:

May 27, 2009 5:28:34 PM (16 years ago)

Author:

vboxsync

Message:

iprt/dir.h: RTDirCreateTemp spec clearification.

File:

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

trunk/include/iprt/dir.h

@@ -60 +60 @@
  *
  * @returns iprt status code.
- * @param   pszPath   Path to the directory to create.
- * @param   fMode      The mode of the new directory.
- */ 
+ * @param   pszPath     Path to the directory to create.
+ * @param   fMode       The mode of the new directory.
+ */
 RTDECL(int) RTDirCreate(const char *pszPath, RTFMODE fMode);
 
@@ -70 +70 @@
  *
  * @returns iprt status code.
- * @param   pszPath   Path to the directory to create.
- * @param   fMode      The mode of the new directories.
+ * @param   pszPath     Path to the directory to create.
+ * @param   fMode       The mode of the new directories.
  */
 RTDECL(int) RTDirCreateFullPath(const char *pszPath, RTFMODE fMode);
 
 /**
- * Creates a directory with a temporary name which is guaranteed not 
- * to exists. It takes a path with a directory name template and 
- * overwrites a portion of it to create the unique name. The template 
- * may be any directory name with some numbers of `Xs` appended to it. 
- * The trailing `Xs` are replaced with the unique numbers. The 
- * directory is created with mode 0700.
- *
- * @returns iprt status code.
- * @param   pszTemplate     Buffer with the template path.
+ * Creates a new temporary directory with a unique name.
+ *
+ * It takes a path with a directory name template and overwrites a portion of it
+ * to create the unique name. The template may be any directory name with one or
+ * more tailing `X`. The trailing `Xs` will be replaced by alpha numeric
+ * characters to create a directory unique name.
+ *
+ * The directory is created with mode 0700.
+ *
+ * @returns iprt status code.
+ * @param   pszTemplate     The directory name template on input. The actual
+ *                          directory name on success. Empty string on failure.
  */
 RTDECL(int) RTDirCreateTemp(char *pszTemplate);