Changeset 80585 in vbox for trunk/include

Timestamp:

Sep 4, 2019 2:05:50 PM (5 years ago)

Author:

vboxsync

Message:

Runtime: Some renaming to stay consistent (*Get* always returns what is asked for while *Query* returns a status code and where to store the value on success is given as a pointer)

• RTVfsFileGetSize -> RTVfsFileQuerySize
• RTFileQuerySize -> RTFileQuerySizeByPath
• RTFileGetSize -> RTFileQuerySize
• RTFileGetSizeMaxEx -> RTFileQuerySizeMaxEx

Location:

trunk/include/iprt

Files:

• file.h (modified) (4 diffs)
• mangling.h (modified) (2 diffs)
• vfs.h (modified) (1 diff)
• vfslowlevel.h (modified) (2 diffs)

trunk/include/iprt/file.h

@@ -94 +94 @@
  * @param   pcbFile         Where to return the file size (bytes).
  *
- * @sa      RTFileGetSize, RTPathQueryInfoEx.
- */
-RTDECL(int) RTFileQuerySize(const char *pszPath, uint64_t *pcbFile);
+ * @sa      RTFileQuerySize, RTPathQueryInfoEx.
+ */
+RTDECL(int) RTFileQuerySizeByPath(const char *pszPath, uint64_t *pcbFile);
 
 
@@ -560 +560 @@
  * @param   pcbSize     Where to store the filesize.
  */
-RTDECL(int)  RTFileGetSize(RTFILE File, uint64_t *pcbSize);
+RTDECL(int)  RTFileQuerySize(RTFILE File, uint64_t *pcbSize);
 
 /**
@@ -568 +568 @@
  *          -1 on failure, the file position is undefined.
  * @param   File        Handle to the file.
- * @see     RTFileGetMaxSizeEx.
+ * @see     RTFileQueryMaxSizeEx.
  */
 RTDECL(RTFOFF) RTFileGetMaxSize(RTFILE File);
@@ -580 +580 @@
  * @see     RTFileGetMaxSize.
  */
-RTDECL(int) RTFileGetMaxSizeEx(RTFILE File, PRTFOFF pcbMax);
+RTDECL(int) RTFileQueryMaxSizeEx(RTFILE File, PRTFOFF pcbMax);
 
 /**

trunk/include/iprt/mangling.h

@@ -932 +932 @@
 # define RTFileFromNative                               RT_MANGLER(RTFileFromNative)
 # define RTFileGetMaxSize                               RT_MANGLER(RTFileGetMaxSize)
-# define RTFileGetMaxSizeEx                             RT_MANGLER(RTFileGetMaxSizeEx)
-# define RTFileGetSize                                  RT_MANGLER(RTFileGetSize)
+# define RTFileQueryMaxSizeEx                           RT_MANGLER(RTFileQueryMaxSizeEx)
+# define RTFileQuerySizeByPath                          RT_MANGLER(RTFileQuerySizeByPath)
 # define RTFileIoCtl                                    RT_MANGLER(RTFileIoCtl)
 # define RTFileIsValid                                  RT_MANGLER(RTFileIsValid)
@@ -2640 +2640 @@
 # define RTVfsFileFromRTFile                            RT_MANGLER(RTVfsFileFromRTFile)
 # define RTVfsFileGetOpenFlags                          RT_MANGLER(RTVfsFileGetOpenFlags)
-# define RTVfsFileGetSize                               RT_MANGLER(RTVfsFileGetSize)
+# define RTVfsFileQuerySize                             RT_MANGLER(RTVfsFileQuerySize)
 # define RTVfsFileGetMaxSize                            RT_MANGLER(RTVfsFileGetMaxSize)
 # define RTVfsFileOpen                                  RT_MANGLER(RTVfsFileOpen)

trunk/include/iprt/vfs.h

@@ -1475 +1475 @@
 
 
-RTDECL(int)         RTVfsFileGetSize(RTVFSFILE hVfsFile, uint64_t *pcbSize);
+RTDECL(int)         RTVfsFileQuerySize(RTVFSFILE hVfsFile, uint64_t *pcbSize);
 RTDECL(RTFOFF)      RTVfsFileGetMaxSize(RTVFSFILE hVfsFile);
 RTDECL(int)         RTVfsFileQueryMaxSize(RTVFSFILE hVfsFile, uint64_t *pcbMax);

trunk/include/iprt/vfslowlevel.h

@@ -1023 +1023 @@
      * @param   pvThis      The implementation specific file data.
      * @param   pcbFile     Where to store the current file size.
-     * @sa      RTFileGetSize
+     * @sa      RTFileQuerySize
      */
     DECLCALLBACKMEMBER(int, pfnQuerySize)(void *pvThis, uint64_t *pcbFile);
@@ -1057 +1057 @@
      * @param   pcbMax      Where to return the max file size.
      * @note    Optional.  If NULL, VERR_NOT_IMPLEMENTED will be returned.
-     * @sa      RTFileGetMaxSizeEx
+     * @sa      RTFileQueryMaxSizeEx
      */
     DECLCALLBACKMEMBER(int, pfnQueryMaxSize)(void *pvThis, uint64_t *pcbMax);