ISAXContentHandler::putDocumentLocator Method

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method receives an interface for locating the origin of SAX (Simple API for XML) document events.

Syntax

HRESULT putDocumentLocator(
  ISAXLocator* pLocator
);

Parameters

• pLocator
  [in] Pointer to the interface pointer to an instance of an implementation of the ISAXLocator interface.

Return Value

• S_OK
  Returned if no errors occur.

• E_FAIL
  Returned if the parse operation should be aborted.

Remarks

The reader supplies a locator to the application by invoking this method before invoking any other methods in the ISAXContentHandler interface. This locator allows the application to determine the end position of any document-related event, even if the parser is not reporting an error. Typically, the application uses this information for reporting its own errors (for example, if the character content does not match an application's business rules).

The information returned by the Locator object can sometimes be insufficient for use with a search engine. The locator returns the correct information only during the invocation of events in this interface. The application should not attempt to use this method at any other time.

Requirements

See Also

Reference

ISAXContentHandler::startDocument Method
ISAXContentHandler