Improved the readline() comment, as it was not quite clear.

This commit is contained in:
mcmullen%netscape.com 1999-02-04 19:25:59 +00:00
parent 7ac7f91e7d
commit 83b7cdb328
2 changed files with 8 additions and 6 deletions

View File

@ -189,9 +189,10 @@ public:
void get(char& c);
PRInt32 read(void* s, PRInt32 n);
PRBool readline(char* s, PRInt32 n);
// Result always null-terminated
// false result indicates line was truncated
// to fit buffer, or an error occurred.
// Result always null-terminated.
// Check eof() before each call.
// CAUTION: false result only indicates line was truncated
// to fit buffer, or an error occurred (OTHER THAN eof).
// Input streamers. Add more as needed
nsBasicInStream& operator >> (char& ch);

View File

@ -189,9 +189,10 @@ public:
void get(char& c);
PRInt32 read(void* s, PRInt32 n);
PRBool readline(char* s, PRInt32 n);
// Result always null-terminated
// false result indicates line was truncated
// to fit buffer, or an error occurred.
// Result always null-terminated.
// Check eof() before each call.
// CAUTION: false result only indicates line was truncated
// to fit buffer, or an error occurred (OTHER THAN eof).
// Input streamers. Add more as needed
nsBasicInStream& operator >> (char& ch);