Share via


IWebBrowser2::get_LocationName

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method uses the LocationName property to get the short, user-friendly name of the document currently being viewed.

Syntax

HRESULT IWebBrowser2::get_LocationName(
  BSTR *pbstrLocationName
);

Parameters

  • pbstrLocationName
    [out] Pointer to a variable of type BSTR that receives the name of the document.

Return Value

This method returns the standard values E_INVALIDARG, E_OUTOFMEMORY, E_UNEXPECTED, and E_FAIL, as well as the following:

  • S_OK
    The method completed successfully.

DISPID

DISPID_WEBBROWSER_LOCATIONNAME

The DISPID is defined in piedocvw.h. Use this value to identify the event handler when implementing IDispatch::Invoke.

Remarks

If the resource is an HTML page, the name is the title of that page. If the resource is a folder or a non-HTML file on the network or local computer, the name is the full path of the folder or file in Universal Naming Convention (UNC) format.

Requirements

Header piedocvw.h
Library piedocvw.lib
Windows Mobile Pocket PC for Windows Mobile Version 5.0 and later, Smartphone for Windows Mobile Version 5.0 and later

See Also

Reference

IWebBrowser2