HlinkNavigateString function

[HlinkNavigateString 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 string, to a new document or object.

Syntax

C++


HRESULT HlinkNavigateString(
  _In_ IUnknown *pUnk,
  _In_ LPCWSTR  szTarget
);

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 the hyperlink originates from an ActiveX-unaware application.
szTarget [in]: The address of a string that identifies the hyperlink target. This string is resolved into a moniker for underlying binding operations through MkParseDisplayNameEx. If this is NULL, the navigation is inside a document.

Return value

Returns S_OK if successful, or an error value otherwise.

Remarks

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

The HlinkNavigateString 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