All Frameworks Class Hierarchy This Framework Indexes Previous Next

XMLParserItf Interface CATISAXLocator

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.

interface CATISAXLocator

Interface for associating a SAX event with a document location.

If a SAX parser provides location information to the SAX application, it does so by implementing this interface and then passing an instance to the application using the document handler's method. The application can use the object to obtain the location of any other document handler event in the XML source document.

Note that the results returned by the object will be valid only during the scope of each document handler method: the application will receive unpredictable results if it attempts to use the locator at any other time.

SAX parsers are not required to supply a locator, but they are very strong encouraged to do so. If the parser supplies a locator, it must do so before reporting any other document events. If no locator has been set by the time the application receives the event, the application should assume that a locator is not available.

See also:

Method Index

o GetColumnNumber(int&): Retrieves the column number where the current document event ends.
o GetLineNumber(int&): Retrieves the line number where the current document event ends.
o GetPublicId(CATUnicodeString&): Retrieves the public identifier for the current document event.
o GetSystemId(CATUnicodeString&): Retrieves the system identifier for the current document event.

Methods

o GetColumnNumber

public virtual GetColumnNumber( oNumber)

Retrieves the column number where the current document event ends. Note that this is the column number of the first character after the text associated with the document event. The first column in a line is position 1.

Parameters:

oNumber: The column number, or -1 if none is available.

See also:

o GetLineNumber

public virtual GetLineNumber( oNumber)

Retrieves the line number where the current document event ends. Note that this is the line position of the first character after the text associated with the document event.

Parameters:

oNumber: The line number, or -1 if none is available.

See also:

o GetPublicId

public virtual GetPublicId( oPublicId)

Retrieves the public identifier for the current document event.

This will be the public identifier

Parameters:

oPublicId: A string containing the public identifier

Returns:

S_OK upon success, or E_FAIL if no public identifier is available.

See also:

o GetSystemId

public virtual GetSystemId( oSystemId)

Retrieves the system identifier for the current document event.

If the system identifier is a URL, the parser must resolve it fully before passing it to the application.

Parameters:

oSystemId: A string containing the system identifier.

Returns:

S_OK upon success, or E_FAIL if no system identifier is available.

See also:

This object is included in the file: CATISAXLocator.h
If needed, your Imakefile.mk should include the module: CatXmlItfBase