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

     1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
     2  *
     3  * This Source Code Form is subject to the terms of the Mozilla Public
     4  * License, v. 2.0. If a copy of the MPL was not distributed with this
     5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     7 #include "nsISupports.idl"
     9 [scriptable, uuid(c97b466c-1e6e-4773-a4ab-2b2b3190a7a6)]
    10 interface nsILineInputStream : nsISupports
    11 {
    12   /**
    13    * Read a single line from the stream, where a line is a 
    14    * possibly zero length sequence of 8bit chars terminated by a
    15    * CR, LF, CRLF, LFCR, or eof.
    16    * The line terminator is not returned.
    17    * @retval false
    18    *         End of file. This line is the last line of the file
    19    *         (aLine is valid).
    20    * @retval true
    21    *         The file contains further lines.
    22    * @note Do not mix readLine with other read functions.
    23    *       Doing so can cause various problems and is not supported.
    24    */
    25   boolean readLine(out ACString aLine);
    26 };

mercurial