Interface nsIURLParserType

nsIURLParser specifies the interface to an URL parser that attempts to follow the definitions of RFC 2396.

Hierarchy

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

  • ParseAuthority breaks the authority string up into its 4 components: username, password, hostname, and hostport.

    auth = :@:

    Parameters

    • authority: string
    • authorityLen: number
    • usernamePos: number
    • usernameLen: number
    • passwordPos: number
    • passwordLen: number
    • hostnamePos: number
    • hostnameLen: number
    • port: number

    Returns void

  • filename = .

    Parameters

    • filename: string
    • filenameLen: number
    • basenamePos: number
    • basenameLen: number
    • extensionPos: number
    • extensionLen: number

    Returns void

  • ParseFilePath breaks the file path string up into: the directory portion, file base name, and file extension.

    filepath = .

    Parameters

    • filepath: string
    • filepathLen: number
    • directoryPos: number
    • directoryLen: number
    • basenamePos: number
    • basenameLen: number
    • extensionPos: number
    • extensionLen: number

    Returns void

  • ParsePath breaks the path string up into its 3 major components: a file path, a query string, and a reference string.

    path = ?#

    Parameters

    • path: string
    • pathLen: number
    • filepathPos: number
    • filepathLen: number
    • queryPos: number
    • queryLen: number
    • refPos: number
    • refLen: number

    Returns void

  • serverinfo = :

    Parameters

    • serverinfo: string
    • serverinfoLen: number
    • hostnamePos: number
    • hostnameLen: number
    • port: number

    Returns void

  • The string to parse in the following methods may be given as a null terminated string, in which case the length argument should be -1.

    Out parameters of the following methods are all optional (ie. the caller may pass-in a NULL value if the corresponding results are not needed). Signed out parameters may hold a value of -1 if the corresponding result is not part of the string being parsed.

    The parsing routines attempt to be as forgiving as possible.

    ParseSpec breaks the URL string up into its 3 major components: a scheme, an authority section (hostname, etc.), and a path.

    spec = ://

    Parameters

    • spec: string
    • specLen: number
    • schemePos: number
    • schemeLen: number
    • authorityPos: number
    • authorityLen: number
    • pathPos: number
    • pathLen: number

    Returns void

  • userinfo = :

    Parameters

    • userinfo: string
    • userinfoLen: number
    • usernamePos: number
    • usernameLen: number
    • passwordPos: number
    • passwordLen: number

    Returns void

Generated using TypeDoc