IHlinkSite::OnNavigationComplete

Notifies the hyperlink site that a hyperlink navigation has been successful. This notification in particularly useful if the hyperlink has been navigated asynchronously because it is the only notification the hyperlink receives to realize that hyperlinking has completed.

HRESULT OnNavigationComplete(
  DWORD dwSiteData, //Site data for the hyperlink object
  DWORD dwReserved, //Reserved for future use
  HRESULT hrError,  //Result of the hyperlink navigation
  LPCWSTR pwzError  //Description of the failure, if any
);
 

Parameters

dwSiteData

[in] Identifies the hyperlink to the hyperlink site. The hyperlink site initializes the hyperlink with this value as part of IHlink::SetHlinkSite.

dwReserved

[in] Reserved for future use; must be set to zero by the caller. To ensure compatibility with future use, the callee must not check for zero.

hrError

[in] Result of the hyperlink navigation. Either S_OK for success or E_ABORT or E_FAIL for failure.

pwzError

[in] Pointer to the string describing the failure that occurred.

Return Values

S_OK

The hyperlink site has been successfully notified.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in hlink.h.

See Also

HlinkOnNavigate, IHlinkBrowseContext::OnNavigateHlink, IHlinkFrame::OnNavigate