Changeset 6429 in vbox for trunk/include/iprt

Timestamp:

Jan 21, 2008 10:22:11 PM (17 years ago)

Author:

vboxsync

Message:

r=bird: file sizes and offets are given as RTFOFF now (the uint64_t use is just legacy that will have to be removed sooner or later). Added a Ex version and filled in the missing documentation. Added a todo about the function *not* working on Windows (vista at least).

File:

• trunk/include/iprt/file.h (modified) (1 diff)

trunk/include/iprt/file.h

@@ -266 +266 @@
 
 /**
- * Determine the maximum file size depending on the file system the file is stored on.
- */
-RTR3DECL(uint64_t) RTFileGetMaxSize(RTFILE File);
+ * Determine the maximum file size. 
+ *  
+ * @returns The max size of the file. 
+ *          -1 on failure, the file position is undefined.
+ * @param   File        Handle to the file. 
+ * @see     RTFileGetMaxSizeEx. 
+ */
+RTR3DECL(RTFOFF) RTFileGetMaxSize(RTFILE File);
+
+/**
+ * Determine the maximum file size. 
+ *  
+ * @returns IPRT status code.
+ * @param   File        Handle to the file. 
+ * @param   pcbMax      Where to store the max file size. 
+ * @see     RTFileGetMaxSize.
+ */
+RTR3DECL(int) RTFileGetMaxSizeEx(RTFILE File, PRTFOFF pcbMax);
+
+/**
+ * Determine the maximum file size depending on the file system the file is stored on. 
+ *  
+ * @returns The max size of the file. 
+ *          -1 on failure.
+ * @param   File        Handle to the file.         
+ */
+RTR3DECL(RTFOFF) RTFileGetMaxSize(RTFILE File);
 
 /**