Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 ISAXLocatorinterface.

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 ISAXContentHandlerinterface. 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 Locatorobject 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

Header msxml2.h, msxml2.idl
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also