Join MDN and developers like you at Mozilla's View Source conference, 12-14 September in Berlin, Germany. Learn more at https://viewsourceconf.org

nsIFileStreams

 

The nsIFileStreams interface is an input stream that allows you to read from a file.

Please add a summary to this article.
  Last changed in Gecko 1.9 (Firefox 3)

Inherits from: nsISupports

Method overview

void init(in nsIFile file, in long ioFlags, in long perm, in long behaviorFlags);

Constants

Constants Value Description
DELETE_ON_CLOSE 1<<1 If this is set, the file will be deleted by the time the stream is closed. It may be removed before the stream is closed if it is possible to delete it and still read from it. If OPEN_ON_READ is defined, and the file was recreated after the first delete, the file will be deleted again when it is closed again.
CLOSE_ON_EOF 1<<2 If this is set, the file will close automatically when the end of the file is reached.
REOPEN_ON_REWIND 1<<3 If this is set, the file will be reopened whenever Seek(0) occurs. If the file is already open and the seek occurs, it will happen naturally. (The file will only be reopened if it is closed for some reason.)

Methods

init()

 void init(
   in nsIFile file, 
   in long ioFlags, 
   in long perm,
   in long behaviorFlags
 );
Parameters
file
File to read from (must QI to nsILocalFile).
ioFlags
File open flags listed in prio.h (see PR_Open documentation) or -1 to open the file in default mode (PR_RDONLY).
perm
File mode bits listed in prio.h or -1 to use the default value (0).
behaviorFlags
Flags specifying various behaviors of the class (see enumerations in the class).

See also

Document Tags and Contributors

 Contributors to this page: Sheppy, Smi, Ayhfung
 Last updated by: Sheppy,