getBaseURL Method (C/C++)

Returns the base URL for the document.

Syntax

HRESULT getBaseURL(
   [out] const wchar_t ** ppwchBaseUrl); 

Parameters

ppwchBaseUrl [out]

The base URL (zero-terminated Unicode string) for the document.

Return Codes

S_OK

The value returned if the URL is successfully returned.

Remarks

The base URL represents the URL of the current XML document. The reader uses this base URL to resolve relative links (either for those links related to the parseURL method or for external entities in an XML document). To resolve these links, the reader uses the base URL in much the same way that an Internet browser uses a Web page's URL to resolve relative links contained on that page.

The base URL may be a complete URL. However, the reader only uses that portion of the URL up to and including the final backslash when resolving links. For instance, the base URL for a document is "http://msdn.microsoft.com/xml/test.xml". The reader would then only use "http://msdn.microsoft.com/xml/" when resolving links.

Here is an example of how the reader uses the base URL to resolve links. The base URL for a document is "http://msdn.microsoft.com/xml/test.xml". In that document, there is a link for "mytest.xml". The reader would resolve this link as "http://msdn.microsoft.com/xml/mytest.xml".

See Also

putBaseURL Method (C/C++) | getSecureBaseURL Method (C/C++) | putSecureBaseURL Method (C/C++)

Applies to: ISAXXMLReader Interface