Changeset 41504 in vbox for trunk/include/iprt/stream.h

Timestamp:

May 30, 2012 6:40:48 PM (13 years ago)

Author:

vboxsync

Message:

RTStrmGetLine: Deal with correctly with \r\n, current handling is stupid as it returns two lines.

File:

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

trunk/include/iprt/stream.h

@@ -223 +223 @@
 /**
  * Reads a line from a file stream.
- * A line ends with a '\\n', '\\0' or the end of the file.
- *
- * @returns iprt status code.
- * @returns VINF_BUFFER_OVERFLOW if the buffer wasn't big enough to read an entire line.
+ *
+ * A line ends with a '\\n', '\\r\\n', '\\0' or the end of the file.
+ *
+ * @returns iprt status code.
+ * @retval  VINF_BUFFER_OVERFLOW if the buffer wasn't big enough to read an
+ *          entire line.
+ * @retval  VERR_BUFFER_OVERFLOW if a lone '\\r' was encountered at the end of
+ *          the buffer and we ended up dropping the following character.
+ *
  * @param   pStream         The stream.
  * @param   pszString       Where to store the line.
  *                          The line will *NOT* contain any '\\n'.
- * @param   cchString       The size of the string buffer.
- */
-RTR3DECL(int) RTStrmGetLine(PRTSTREAM pStream, char *pszString, size_t cchString);
+ * @param   cbString        The size of the string buffer.
+ */
+RTR3DECL(int) RTStrmGetLine(PRTSTREAM pStream, char *pszString, size_t cbString);
 
 /**