Interface nsIExpatSinkType

This interface should be implemented by any content sink that wants to get output from expat and do something with it; in other words, by any sink that handles some sort of XML dialect.

Hierarchy

Methods

AddRef HandleCDataSection HandleCharacterData HandleComment HandleDoctypeDecl HandleEndElement HandleProcessingInstruction HandleStartElement HandleXMLDeclaration QueryInterface Release ReportError

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

HandleCDataSection

  • Called to handle a CDATA section

    Parameters

    • aData: wstring

      the text in the CDATA section. This is null-terminated.

    • aLength: number

      the length of the aData string

    Returns void

HandleCharacterData

  • Called to handle character data. Note that this does NOT get called for the contents of CDATA sections.

    Parameters

    • aData: wstring

      the data to handle. aData is NOT NULL-TERMINATED.

    • aLength: number

      the length of the aData string

    Returns void

HandleComment

  • Called to handle a comment

    Parameters

    • aCommentText: wstring

      the text of the comment (not including the "")

    Returns void

HandleDoctypeDecl

  • Called to handle the doctype declaration

    Parameters

    • aSubset: string
    • aName: string
    • aSystemId: string
    • aPublicId: string
    • aCatalogData: nsISupports

    Returns void

HandleEndElement

  • Called to handle the closing tag of an element.

    Parameters

    • aName: wstring

      the fully qualified tagname of the element

    Returns void

HandleProcessingInstruction

  • Called to handle a processing instruction

    Parameters

    • aTarget: wstring

      the PI target (e.g. xml-stylesheet)

    • aData: wstring

      all the rest of the data in the PI

    Returns void

HandleStartElement

  • Called to handle the opening tag of an element.

    Parameters

    • aName: wstring

      the fully qualified tagname of the element

    • aAtts: wstring

      the array of attribute names and values. There are aAttsCount/2 names and aAttsCount/2 values, so the total number of elements in the array is aAttsCount. The names and values alternate. Thus, if we number attributes starting with 0, aAtts[2k] is the name of the k-th attribute and aAtts[2k+1] is the value of that attribute Both explicitly specified attributes and attributes that are defined to have default values in a DTD are present in aAtts.

    • aAttsCount: number

      the number of elements in aAtts.

    • aLineNumber: number

      the line number of the start tag in the data stream.

    • aColumnNumber: number

      the column number of the start tag in the data stream.

    Returns void

HandleXMLDeclaration

  • Handle the XML Declaration.

    Parameters

    • aVersion: wstring

      The version string, can be null if not specified.

    • aEncoding: wstring

      The encoding string, can be null if not specified.

    • aStandalone: number

      1, 0, or 1 indicating respectively that there was no standalone parameter in the declaration, that it was given as no, or that it was given as yes.

    Returns void

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

ReportError

  • Ask the content sink if the expat driver should log an error to the console.

    Retval

    True if the expat driver should report the error.

    Parameters

    • aErrorText: wstring

      Error message to pass to content sink.

    • aSourceText: wstring

      Source text of the document we're parsing.

    • aError: nsIScriptError

      Script error object with line number & column number

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc