Interface nsISearchableInputStreamType

XXX this interface doesn't really belong in here. It is here because currently nsPipeInputStream is the only implementation of this interface.

Hierarchy

Methods

AddRef QueryInterface Release search

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

search

  • 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.

    Parameters

    • forString: string
    • ignoreCase: boolean
    • found: boolean
    • offsetSearchedTo: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc