Changeset 100930 in vbox for trunk

Timestamp:

Aug 21, 2023 11:10:07 PM (18 months ago)

Author:

vboxsync

Message:

IPRT/vfs: Added RTVfsFileReadAll and RTVfsFileReadAllFree.

Location:

trunk

Files:

• include/iprt/mangling.h (modified) (1 diff)
• include/iprt/vfs.h (modified) (4 diffs)
• src/VBox/Runtime/common/vfs/vfsiosmisc.cpp (modified) (1 diff)

trunk/include/iprt/mangling.h

@@ -2916 +2916 @@
 # define RTVfsFileQueryMaxSize                          RT_MANGLER(RTVfsFileQueryMaxSize)
 # define RTVfsFileRead                                  RT_MANGLER(RTVfsFileRead)
+# define RTVfsFileReadAll                               RT_MANGLER(RTVfsFileReadAll)
+# define RTVfsFileReadAllFree                           RT_MANGLER(RTVfsFileReadAllFree)
 # define RTVfsFileReadAt                                RT_MANGLER(RTVfsFileReadAt)
 # define RTVfsFileRelease                               RT_MANGLER(RTVfsFileRelease)

trunk/include/iprt/vfs.h

@@ -1066 +1066 @@
  * Reads the remainder of the stream into a memory buffer.
  *
- * For simplifying string-style processing, the is a zero byte after the
+ * For simplifying string-style processing, there is a zero byte after the
  * returned buffer, making sure it can be used as a zero terminated string.
  *
@@ -1074 +1074 @@
  *                          RTVfsIoStrmReadAllFree for freeing, not RTMemFree!
  * @param   pcbBuf          Where to return the buffer size.
+ * @sa      RTVfsFileReadAll
  */
 RTDECL(int)         RTVfsIoStrmReadAll(RTVFSIOSTREAM hVfsIos, void **ppvBuf, size_t *pcbBuf);
@@ -1082 +1083 @@
  * @param   pvBuf           What RTVfsIoStrmReadAll returned.
  * @param   cbBuf           What RTVfsIoStrmReadAll returned.
+ * @sa      RTVfsFileReadAllFree
  */
 RTDECL(void)        RTVfsIoStrmReadAllFree(void *pvBuf, size_t cbBuf);
@@ -1408 +1410 @@
 RTDECL(int)         RTVfsFileRead(RTVFSFILE hVfsFile, void *pvBuf, size_t cbToRead, size_t *pcbRead);
 RTDECL(int)         RTVfsFileReadAt(RTVFSFILE hVfsFile, RTFOFF off, void *pvBuf, size_t cbToRead, size_t *pcbRead);
+
+/**
+ * Reads the remainder of the file into a memory buffer.
+ *
+ * For simplifying string-style processing, there is a zero byte after the
+ * returned buffer, making sure it can be used as a zero terminated string.
+ *
+ * @returns IPRT status code.
+ * @param   hVfsIos         The VFS I/O stream handle.
+ * @param   ppvBuf          Where to return the buffer.  Must pass to
+ *                          RTVfsFileReadAllFree for freeing, not RTMemFree!
+ * @param   pcbBuf          Where to return the buffer size.
+ * @sa      RTVfsIoStrmReadAll
+ */
+RTDECL(int)         RTVfsFileReadAll(RTVFSFILE hVfsFile, void **ppvBuf, size_t *pcbBuf);
+
+/**
+ * Free memory buffer returned by RTVfsFileReadAll.
+ *
+ * @param   pvBuf           What RTVfsFileReadAll returned.
+ * @param   cbBuf           What RTVfsFileReadAll returned.
+ * @sa      RTVfsIoStrmReadAllFree
+ */
+RTDECL(void)        RTVfsFileReadAllFree(void *pvBuf, size_t cbBuf);
 
 /**

trunk/src/VBox/Runtime/common/vfs/vfsiosmisc.cpp

@@ -237 +237 @@
 }
 
+
+RTDECL(int) RTVfsFileReadAll(RTVFSFILE hVfsFile, void **ppvBuf, size_t *pcbBuf)
+{
+    RTVFSIOSTREAM hVfsIos = RTVfsFileToIoStream(hVfsFile);
+    int rc = RTVfsIoStrmReadAll(hVfsIos, ppvBuf, pcbBuf);
+    RTVfsIoStrmRelease(hVfsIos);
+    return rc;
+}
+
+
+RTDECL(void) RTVfsFileReadAllFree(void *pvBuf, size_t cbBuf)
+{
+    RTVfsIoStrmReadAllFree(pvBuf, cbBuf);
+}
+