Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsISearchableInputStream Interface Reference

XXX this interface doesn't really belong in here. More...

import "nsIPipe.idl";

Inheritance diagram for nsISearchableInputStream:
Inheritance graph
Collaboration diagram for nsISearchableInputStream:
Collaboration graph

List of all members.

Public Member Functions

void search (in string forString, in boolean ignoreCase, out boolean found, out unsigned long offsetSearchedTo)
 Searches for a string in the input stream.

Detailed Description

XXX this interface doesn't really belong in here.

It is here because currently nsPipeInputStream is the only implementation of this interface.

Definition at line 99 of file nsIPipe.idl.

Member Function Documentation

void nsISearchableInputStream::search ( in string  forString,
in boolean  ignoreCase,
out boolean  found,
out unsigned long  offsetSearchedTo 

Searches for a string in the input stream.

Since the stream has a notion of EOF, it is possible that the string may at some time be in the buffer, but is is not currently found up to some offset. Consequently, both the found and not found cases return an offset: if found, return offset where it was found if not found, return offset of the first byte not searched In the case the stream is at EOF and the string is not found, the first byte not searched will correspond to the length of the buffer.

The documentation for this interface was generated from the following file: