Changeset 70890 in vbox for trunk/include

Timestamp:

Feb 7, 2018 2:05:43 PM (7 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

120716

Message:

IPRT: dir.c,dir-posix.cpp,direnum-nt.cpp: Implemented RTDIR_F_NO_FOLLOW on posix, adjusted NT implementation and documented the VERR_IS_A_SYMLINK return code for the relevant APIs.

File:

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

trunk/include/iprt/dir.h

@@ -361 +361 @@
  * Opens a directory with flags and optional filtering.
  *
- * @returns iprt status code.
+ * @returns IPRT status code.
+ * @retval  VERR_IS_A_SYMLINK if RTDIR_F_NO_FOLLOW is set, @a enmFilter is
+ *          RTDIRFILTER_NONE and @a pszPath points to a symbolic link and does
+ *          not end with a slash.  Note that on Windows this does not apply to
+ *          file symlinks, only directory symlinks, for the file variant
+ *          VERR_NOT_A_DIRECTORY will be returned.
+ *
  * @param   phDir       Where to store the open directory handle.
  * @param   pszPath     Path to the directory to search, this must include wildcards.
@@ -367 +373 @@
  *                      this function behave like RTDirOpen.
  * @param   fFlags      Open flags, RTDIR_F_XXX.
+ *
  */
 RTDECL(int) RTDirOpenFiltered(RTDIR *phDir, const char *pszPath, RTDIRFILTER enmFilter, uint32_t fFlags);
@@ -625 +632 @@
  *
  * @returns IPRT status code.
+ * @retval  VERR_IS_A_SYMLINK if RTDIR_F_NO_FOLLOW is set, @a enmFilter is
+ *          RTDIRFILTER_NONE and @a pszPath points to a symbolic link and does
+ *          not end with a slash.  Note that on Windows this does not apply to
+ *          file symlinks, only directory symlinks, for the file variant
+ *          VERR_NOT_A_DIRECTORY will be returned.
+ *
  * @param   hDir            The directory to open relative to.
  * @param   pszDirAndFilter The relative path to the directory to search, this