HlinkOnNavigate function

[HlinkOnNavigate may be altered or unavailable in subsequent versions of the operating system or product.]

Note  The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

Notifies a hyperlink browse context and hyperlink frame, if it exists, that a hyperlink target has been navigated to.

Syntax

HRESULT HlinkOnNavigate(
  _In_  IHlinkFrame         *pihlframe,
  _In_  IHlinkBrowseContext *pihlbc,
  _In_  DWORD               grfHLNF,
  _In_  IMoniker            *pimkTarget,
  _In_  LPCWSTR             pwzLocation,
  _In_  LPCWSTR             pwzFriendlyName,
  _Out_ unsigned long       *puHLID
);

Parameters

• pihlframe [in]
  The address of the IHlinkFrame interface of the hyperlink container. This can be NULL, if the hyperlink container does not have a hyperlink frame.

• pihlbc [in]
  The address of the IHlinkBrowseContext interface for the browse context object to use for this navigation. The browse context includes history information, where this navigation is logged if grfHLNF is not set to HLNF_CREATENOHISTORY.

• grfHLNF [in]
  A value taken from the HLNF enumeration.

• pimkTarget [in]
  The address of an IMoniker interface on the hyperlink target.

• pwzLocation [in]
  The address of the location in the hyperlink target of the new hyperlink object.

• pwzFriendlyName [in]
  The address of the friendly name of the hyperlink.

• puHLID [out]
  The address of the hyperlink identifier to set in the current browse context's navigation stack.

Return value

Returns S_OK if successful.

Examples

HlinkOnNavigate is a helper function called during IHlinkTarget::Navigate, which encapsulates the following calls.

phlbc->OnNavigateHlink(grfHLNF, pimkTarget, pwzLocation, pwzFriendlyName);
if (phlFrame)
    phlFrame->OnNavigate(grfHLNF);

Requirements

See also

Reference

IHlinkBrowseContext::OnNavigateHlink

IHlinkFrame::OnNavigate

IHlinkSite::OnNavigationComplete