Interface nsINestedURIType

nsINestedURI is an interface that must be implemented by any nsIURI implementation which has an "inner" URI that it actually gets data from.

For example, if URIs for the scheme "sanitize" have the structure:

sanitize:http://example.com

and opening a channel on such a sanitize: URI gets the data from http://example.com, sanitizes it, and returns it, then the sanitize: URI should implement nsINestedURI and return the http://example.com URI as its inner URI.

Hierarchy

Properties

innerURI: nsIURI

The inner URI for this nested URI. This must not return null if the getter succeeds; URIs that have no inner must not QI to this interface. Dynamically changing whether there is an inner URI is not allowed.

Modifying the returned URI must not in any way modify the nested URI; this means the returned URI must be either immutable or a clone.

innermostURI: nsIURI

The innermost URI for this nested URI. This must not return null if the getter succeeds. This is equivalent to repeatedly calling innerURI while the returned URI QIs to nsINestedURI.

Modifying the returned URI must not in any way modify the nested URI; this means the returned URI must be either immutable or a clone.

Methods

  • 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

  • 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

  • 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

Generated using TypeDoc