Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes
nsScriptableInputStream Class Reference

#include <nsScriptableInputStream.h>

Inheritance diagram for nsScriptableInputStream:
Inheritance graph
[legend]
Collaboration diagram for nsScriptableInputStream:
Collaboration graph
[legend]

List of all members.

Public Member Functions

NS_DECL_ISUPPORTS
NS_DECL_NSISCRIPTABLEINPUTSTREAM 
nsScriptableInputStream ()
void close ()
 Closes the stream.
void init (in nsIInputStream aInputStream)
 Wrap the given nsIInputStream with this nsIScriptableInputStream.
unsigned long available ()
 Return the number of bytes currently available in the stream.
string read (in unsigned long aCount)
 Read data from the stream.

Static Public Member Functions

static NS_METHOD Create (nsISupports *aOuter, REFNSIID aIID, void **aResult)

Private Member Functions

 ~nsScriptableInputStream ()

Private Attributes

nsCOMPtr< nsIInputStreammInputStream

Detailed Description

Definition at line 51 of file nsScriptableInputStream.h.


Constructor & Destructor Documentation

NS_DECL_ISUPPORTS NS_DECL_NSISCRIPTABLEINPUTSTREAM nsScriptableInputStream::nsScriptableInputStream ( ) [inline]

Definition at line 60 of file nsScriptableInputStream.h.

{};

Here is the caller graph for this function:

Definition at line 66 of file nsScriptableInputStream.h.

{};

Member Function Documentation

unsigned long nsIScriptableInputStream::available ( ) [inherited]

Return the number of bytes currently available in the stream.

Parameters:
_retval[out] parameter to hold the number of bytes if an error occurs, the parameter will be undefined
Returns:
error status

Closes the stream.

NS_METHOD nsScriptableInputStream::Create ( nsISupports *  aOuter,
REFNSIID  aIID,
void **  aResult 
) [static]

Definition at line 92 of file nsScriptableInputStream.cpp.

                                                                                  {
    if (aOuter) return NS_ERROR_NO_AGGREGATION;

    nsScriptableInputStream *sis = new nsScriptableInputStream();
    if (!sis) return NS_ERROR_OUT_OF_MEMORY;

    NS_ADDREF(sis);
    nsresult rv = sis->QueryInterface(aIID, aResult);
    NS_RELEASE(sis);
    return rv;
}

Here is the call graph for this function:

void nsIScriptableInputStream::init ( in nsIInputStream  aInputStream) [inherited]

Wrap the given nsIInputStream with this nsIScriptableInputStream.

Parameters:
aInputStream[in] parameter providing the stream to wrap
string nsIScriptableInputStream::read ( in unsigned long  aCount) [inherited]

Read data from the stream.

Parameters:
aCount[in] the maximum number of bytes to read
_retval[out] the data

Member Data Documentation

Definition at line 66 of file nsScriptableInputStream.h.


The documentation for this class was generated from the following files: