Changeset 23332 in vbox for trunk/include/iprt

Timestamp:

Sep 25, 2009 1:26:57 PM (16 years ago)

Author:

vboxsync

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

52844

Message:

iprt/linux/sysfs.h/cpp: code review, fixing RTLinuxSysFsGetLinkDest[V] termination issue, use RTPathAppend as rtLinuxConstructPath[V] isn't entirely safe, RTLinuxFindDevicePath[V] return value clearification, code style cleanups. Untested.

File:

• trunk/include/iprt/linux/sysfs.h (modified) (4 diffs)

trunk/include/iprt/linux/sysfs.h

@@ -36 +36 @@
 #include <iprt/stdarg.h>
 
-#include <sys/types.h>
+#include <sys/types.h> /* for dev_t */
 
 RT_C_DECLS_BEGIN
@@ -171 +171 @@
  * directory.
  *
- * @returns The number of characters written on success, -1 and errno on failure.
+ * @returns The length of the returned string on success, -1 and errno on
+ *          failure.
  * @param   pszBuf      Where to store the path element.  Must be at least two
  *                      characters, but a longer buffer would be advisable.
@@ -188 +189 @@
  * directory.
  *
- * @returns The number of characters written on success, -1 and errno on failure.
+ * @returns The length of the returned string on success, -1 and errno on
+ *          failure.
  * @param   pszBuf      Where to store the path element.  Must be at least two
  *                      characters, but a longer buffer would be advisable.
@@ -198 +200 @@
 
 /**
- * Find the path of a device node under /dev, given then device number.  This
- * function will recursively search under /dev until it finds a device node
+ * Find the path of a device node under /dev, given then device number.
+ *
+ * This function will recursively search under /dev until it finds a device node
  * matching @a devnum, and store the path into @a pszBuf.  The caller may
  * provide an expected path in pszSuggestion, which will be tried before
  * searching, but due to the variance in Linux systems it can be hard to always
  * correctly predict the path.
- * 
- * @returns the number of characters written on success, -1 and errno on
- *          failure
- * @returns -1 and ENOENT if no matching device node could be found
- * @param  devNum         the device number to search for
- * @param  fMode          the type of device - only RTFS_TYPE_DEV_CHAR
- *                        and RTFS_TYPE_DEV_BLOCK are valid values
- * @param  pszBuf         where to store the path
- * @param  cchBuf         the size of the buffer
- * @param  pszSuggestion  the expected path format of the device node, either
- *                        absolute or relative to "/dev" (optional)
- * @param  va             Format args.
- */
-RTDECL(ssize_t) RTLinuxFindDevicePathV(dev_t devNum, RTFMODE fMode, char *pszBuf, size_t cchBuf, const char *pszSuggestion, va_list va);
-
-/**
- * Find the path of a device node under /dev, given then device number.  This
- * function will recursively search under /dev until it finds a device node
+ *
+ * @returns The length of the returned string on success, -1 and errno on
+ *          failure.
+ * @returns -1 and ENOENT if no matching device node could be found.
+ * @param   DevNum         The device number to search for.
+ * @param   fMode          The type of device - only RTFS_TYPE_DEV_CHAR and
+ *                         RTFS_TYPE_DEV_BLOCK are valid values.
+ * @param   pszBuf         Where to store the path.
+ * @param   cchBuf         The size of the buffer.
+ * @param   pszSuggestion  The expected path format of the device node, either
+ *                         absolute or relative to "/dev". (Optional)
+ * @param   va             Format args.
+ */
+RTDECL(ssize_t) RTLinuxFindDevicePathV(dev_t DevNum, RTFMODE fMode, char *pszBuf, size_t cchBuf,
+                                       const char *pszSuggestion, va_list va);
+
+/**
+ * Find the path of a device node under /dev, given the device number.
+ *
+ * This function will recursively search under /dev until it finds a device node
  * matching @a devnum, and store the path into @a pszBuf.  The caller may
  * provide an expected path in pszSuggestion, which will be tried before
  * searching, but due to the variance in Linux systems it can be hard to always
  * correctly predict the path.
- * 
- * @returns the number of characters written on success, -1 and errno on
- *          failure
- * @returns -1 and ENOENT if no matching device node could be found
- * @param  devNum         the device number to search for
- * @param  fMode          the type of device - only RTFS_TYPE_DEV_CHAR
- *                        and RTFS_TYPE_DEV_BLOCK are valid values
- * @param  pszBuf         where to store the path
- * @param  cchBuf         the size of the buffer
- * @param  pszSuggestion  the expected path format of the device node, either
- *                        absolute or relative to "/dev" (optional)
- * @param  ...            Format args.
- */
-RTDECL(ssize_t) RTLinuxFindDevicePath(dev_t devNum, RTFMODE fMode, char *pszBuf, size_t cchBuf, const char *pszSuggestion, ...);
+ *
+ * @returns The length of the returned string on success, -1 and errno on
+ *          failure.
+ * @returns -1 and ENOENT if no matching device node could be found.
+ * @param   DevNum          The device number to search for
+ * @param   fMode           The type of device - only RTFS_TYPE_DEV_CHAR and
+ *                          RTFS_TYPE_DEV_BLOCK are valid values
+ * @param   pszBuf          Where to store the path.
+ * @param   cchBuf          The size of the buffer.
+ * @param   pszSuggestion   The expected path format of the device node, either
+ *                          absolute or relative to "/dev". (Optional)
+ * @param   ...             Format args.
+ */
+RTDECL(ssize_t) RTLinuxFindDevicePath(dev_t DevNum, RTFMODE fMode, char *pszBuf, size_t cchBuf,
+                                      const char *pszSuggestion, ...);
 
 /** @} */