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.

nsISearchableInputStream

IID:8C39EF62-F7C9-11d4-98F5-001083010E9B
Inherits From:nsISupports

Methods

void search ( char* forString , PRBool ignoreCase , out PRBool found , out PRUint32 offsetSearchedTo )

void search ( char* forString , PRBool ignoreCase , out PRBool found , out PRUint32 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.

Arguments:
forString
ignoreCase
found
offsetSearchedTo

Reference documentation is generated from Mozilla's source.