WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

@mozilla.org/network/file-input-stream;1

This component implements the following interfaces:

Constants

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.

PRInt32 nsIFileInputStream.DELETE_ON_CLOSE = 2
If this is set, the file will close automatically when the end of the file is reached.
PRInt32 nsIFileInputStream.CLOSE_ON_EOF = 4
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.)
PRInt32 nsIFileInputStream.REOPEN_ON_REWIND = 8
PRInt32 nsISeekableStream.NS_SEEK_SET = 0
PRInt32 nsISeekableStream.NS_SEEK_CUR = 1
PRInt32 nsISeekableStream.NS_SEEK_END = 2

Methods

InterfaceMethod
nsIInputStream PRUint32 available ( )
nsIInputStream void close ( )
nsIFileInputStream void init ( nsIFile file , PRInt32 ioFlags , PRInt32 perm , PRInt32 behaviorFlags )
nsIInputStream PRBool isNonBlocking ( )
nsIInputStream [noscript] PRUint32 read ( charPtr* buf , PRUint32 count )
nsILineInputStream PRBool readLine ( out ACString line )
nsIInputStream [noscript] PRUint32 readSegments ( nsWriteSegmentFun writer , voidPtr* closure , PRUint32 count )
nsISeekableStream void seek ( PRInt32 whence , PRInt64 offset )
nsISeekableStream void setEOF ( )
nsISeekableStream PRInt64 tell ( )

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com