Changeset 21801 in vbox for trunk/include

Timestamp:

Jul 26, 2009 5:45:31 PM (16 years ago)

Author:

vboxsync

Message:

IPRT: Clearified RTFileReadAll*.

File:

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

trunk/include/iprt/file.h

@@ -722 +722 @@
  * @param   pszFilename     The name of the file.
  * @param   ppvFile         Where to store the pointer to the memory on successful return.
- * @param   pcbFile         Where to store the size of the file on successful return.
+ * @param   pcbFile         Where to store the size of the returned memory.
  *
  * @remarks Note that this function may be implemented using memory mapping, which means
@@ -745 +745 @@
  * @param   fFlags          See RTFILE_RDALL_*.
  * @param   ppvFile         Where to store the pointer to the memory on successful return.
- * @param   pcbFile         Where to store the size of the file on successful return.
+ * @param   pcbFile         Where to store the size of the returned memory.
  *
  * @remarks See the remarks for RTFileReadAll.
@@ -759 +759 @@
  * @param   File            The handle to the file.
  * @param   ppvFile         Where to store the pointer to the memory on successful return.
- * @param   pcbFile         Where to store the size of the file on successful return.
+ * @param   pcbFile         Where to store the size of the returned memory.
  *
  * @remarks See the remarks for RTFileReadAll.
@@ -777 +777 @@
  * @param   fFlags          See RTFILE_RDALL_*.
  * @param   ppvFile         Where to store the pointer to the memory on successful return.
- * @param   pcbFile         Where to store the size of the file on successful return.
+ * @param   pcbFile         Where to store the size of the returned memory.
  *
  * @remarks See the remarks for RTFileReadAll.