xpcom/io/nsILineInputStream.idl

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/xpcom/io/nsILineInputStream.idl	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,26 @@
     1.4 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
     1.5 + *
     1.6 + * This Source Code Form is subject to the terms of the Mozilla Public
     1.7 + * License, v. 2.0. If a copy of the MPL was not distributed with this
     1.8 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
     1.9 +
    1.10 +#include "nsISupports.idl"
    1.11 +
    1.12 +[scriptable, uuid(c97b466c-1e6e-4773-a4ab-2b2b3190a7a6)]
    1.13 +interface nsILineInputStream : nsISupports
    1.14 +{
    1.15 +  /**
    1.16 +   * Read a single line from the stream, where a line is a 
    1.17 +   * possibly zero length sequence of 8bit chars terminated by a
    1.18 +   * CR, LF, CRLF, LFCR, or eof.
    1.19 +   * The line terminator is not returned.
    1.20 +   * @retval false
    1.21 +   *         End of file. This line is the last line of the file
    1.22 +   *         (aLine is valid).
    1.23 +   * @retval true
    1.24 +   *         The file contains further lines.
    1.25 +   * @note Do not mix readLine with other read functions.
    1.26 +   *       Doing so can cause various problems and is not supported.
    1.27 +   */
    1.28 +  boolean readLine(out ACString aLine);
    1.29 +};

mercurial