Back to index

lightning-sunbird  0.9+nobinonly
Classes | Typedefs | Functions
nsIOutputStream.idl File Reference
import "nsISupports.idl";
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

interface  nsIOutputStream
 nsIOutputStream More...

Typedefs

typedef NS_CALLBACKnsReadSegmentFun )(nsIOutputStream *aOutStream, void *aClosure, char *aToSegment, PRUint32 aFromOffset, PRUint32 aCount, PRUint32 *aReadCount)
 The signature for the reader function passed to WriteSegments.

Functions

native nsReadSegmentFun (nsReadSegmentFun)

Typedef Documentation

typedef NS_CALLBACK( nsReadSegmentFun)(nsIOutputStream *aOutStream, void *aClosure, char *aToSegment, PRUint32 aFromOffset, PRUint32 aCount, PRUint32 *aReadCount)

The signature for the reader function passed to WriteSegments.

This is the "provider" of data that gets written into the stream's buffer.

Parameters:
aOutStreamstream being written to
aClosureopaque parameter passed to WriteSegments
aToSegmentpointer to memory owned by the output stream
aFromOffsetamount already written (since WriteSegments was called)
aCountlength of toSegment
aReadCountnumber of bytes written

Implementers should return the following:

Returns:
NS_OK and (*aReadCount > 0) if successfully provided some data
NS_OK and (*aReadCount = 0) or
<any-error> if not interested in providing any data

Errors are never passed to the caller of WriteSegments.

FROZEN

Definition at line 67 of file nsIOutputStream.idl.


Function Documentation