HlinkNavigateMoniker function

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

Executes a hyperlink jump, that is specified by a moniker, to a new document or object.

Syntax

HRESULT HlinkNavigateMoniker(
  _In_ IUnknown *pUnk,
  _In_ IMoniker *pmkTarget
);

Parameters

  • pUnk [in]
    The address of the IUnknown interface on the document or object that is initiating the hyperlink. If this is NULL, it is assumed that the hyperlink originates from a ActiveX-unaware application.

  • pmkTarget [in]
    The address of the moniker that identifies the hyperlink target. If this is NULL, the navigation is inside a document.

Return value

Returns S_OK if successful. This function can also return any value returned by IHlink::Navigate.

Remarks

HlinkNavigateMoniker is implemented as a simple macro that calls the HlinkSimpleNavigateToMoniker function, passing it NULL for most parameters.

The HlinkNavigateMoniker helper function can be used by all applications, documents, and objects that have simple navigation requirements. The simple hyperlink navigation model enables a user to jump from one page to another page, but does not provide support for more complex operations, such as cutting and pasting hyperlinks. This function performs navigation, if it originates in a hyperlink frame.

Requirements

Minimum supported client

Windows XP

Minimum supported server

Windows 2000 Server

Header

Urlmon.h

Library

Urlmon.lib

DLL

Urlmon.dll

See also

Reference

HLNF

HlinkNavigateString

HlinkNavigateToStringReference