xpcom/io/nsILineInputStream.idl@b8a032363ba2 (annotated)
xpcom/io/nsILineInputStream.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| michael@0 | 2 | * |
| michael@0 | 3 | * This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 4 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 5 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 6 | |
| michael@0 | 7 | #include "nsISupports.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | [scriptable, uuid(c97b466c-1e6e-4773-a4ab-2b2b3190a7a6)] |
| michael@0 | 10 | interface nsILineInputStream : nsISupports |
| michael@0 | 11 | { |
| michael@0 | 12 | /** |
| michael@0 | 13 | * Read a single line from the stream, where a line is a |
| michael@0 | 14 | * possibly zero length sequence of 8bit chars terminated by a |
| michael@0 | 15 | * CR, LF, CRLF, LFCR, or eof. |
| michael@0 | 16 | * The line terminator is not returned. |
| michael@0 | 17 | * @retval false |
| michael@0 | 18 | * End of file. This line is the last line of the file |
| michael@0 | 19 | * (aLine is valid). |
| michael@0 | 20 | * @retval true |
| michael@0 | 21 | * The file contains further lines. |
| michael@0 | 22 | * @note Do not mix readLine with other read functions. |
| michael@0 | 23 | * Doing so can cause various problems and is not supported. |
| michael@0 | 24 | */ |
| michael@0 | 25 | boolean readLine(out ACString aLine); |
| michael@0 | 26 | }; |
