Changeset 24889 in vbox for trunk/include/iprt

Timestamp:

Nov 24, 2009 11:09:45 AM (15 years ago)

Author:

vboxsync

Message:

IPRT: Added RTFileQueryFsSizes.

Location:

trunk/include/iprt

Files:

• file.h (modified) (2 diffs)
• fs.h (modified) (1 diff)

trunk/include/iprt/file.h

@@ -643 +643 @@
  *
  * @returns iprt status code.
- * @returns VERR_NOT_SUPPORTED is returned if the operation isn't supported by the OS.
+ * @retval  VERR_NOT_SUPPORTED is returned if the operation isn't supported by
+ *          the OS.
  *
  * @param   File                Handle to the file.
@@ -744 +745 @@
  */
 RTR3DECL(int) RTFileIoCtl(RTFILE File, int iRequest, void *pvData, unsigned cbData, int *piRet);
+
+/**
+ * Query the sizes of a filesystem.
+ *
+ * @returns iprt status code.
+ * @retval  VERR_NOT_SUPPORTED is returned if the operation isn't supported by
+ *          the OS.
+ *
+ * @param   hFile       The file handle.
+ * @param   pcbTotal    Where to store the total filesystem space. (Optional)
+ * @param   pcbFree     Where to store the remaining free space in the filesystem. (Optional)
+ * @param   pcbBlock    Where to store the block size. (Optional)
+ * @param   pcbSector   Where to store the sector size. (Optional)
+ *
+ * @sa      RTFsQuerySizes
+ */
+RTR3DECL(int) RTFileQueryFsSizes(RTFILE hFile, PRTFOFF pcbTotal, RTFOFF *pcbFree,
+                                 uint32_t *pcbBlock, uint32_t *pcbSector);
 
 /**

trunk/include/iprt/fs.h

@@ -341 +341 @@
  * @param   pcbBlock        Where to store the block size. (Optional)
  * @param   pcbSector       Where to store the sector size. (Optional)
+ *
+ * @sa      RTFileQueryFsSizes
  */
 RTR3DECL(int) RTFsQuerySizes(const char *pszFsPath, PRTFOFF pcbTotal, RTFOFF *pcbFree,