HlinkNavigate function

Article
08/15/2017

[HlinkNavigate 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.

Navigates to a hyperlink, given a hyperlink object and an optional hyperlink frame object.

Syntax

HRESULT HlinkNavigate(
  _In_ IHlink              *pihl,
  _In_ IHlinkFrame         *pihlframe,
  _In_ DWORD               grfHLNF,
  _In_ LPBC                pbc,
  _In_ IBindStatusCallback *pibsc,
  _In_ IHlinkBrowseContext *pihlbc
);

Parameters

pihl [in]
The address of the IHlink interface on the target hyperlink.
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.
grfHLNF [in]
The value taken from the HLNF enumeration.
pbc [in]
The address of the IBindCtx interface on the bind context to use for any moniker binding performed during the navigation. This must not be NULL.
pibsc [in]
The address of the IBindStatusCallback interface on the bind status context to use for any asynchronous moniker binding performed during the navigation. If this is NULL, the caller does not receive progress notification, cancellation, pausing, or low-level binding information.
pihlbc [in]
The address of the IHlinkBrowseContext interface pointer to use for this navigation. The browse context includes history information, where this navigation is logged, if grfHLNF is not set to HLNF_CREATENOHISTORY.

Return value

Returns S_OK if successful, or an error value otherwise.

Examples

HlinkNavigate encapsulates the following common sequence of calls.

if (phlFrame)
    phlFrame->Navigate(grfHLNF, pbc, pbsc, phl);
else if (phl)
    phl->Navigate(grfHLNF, pbc, pbsc, phlbc);

Requirements

Minimum supported client	Windows XP
Minimum supported server	Windows 2000 Server
Header	Hlink.h
Library	Hlink.lib
DLL	Hlink.dll

Share via