HlinkNavigateString Function

---

Executes a hyperlink jump, specified by a string, to a new document or object. For information about how this function relates to HlinkSimpleNavigateToString, see the Remarks section.

Syntax

HRESULT HlinkNavigateString(
    IUnknown *pUnk,    
    LPCWSTR szTarget    
);

Parameters

pUnk

[in] 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] 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 within a document.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

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

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

Function Information

Windows NT	Use version 4.0
Windows	Use Windows 95 and later
Header	Urlmon.h
Import Library	Urlmon.lib
Minimum availability	Internet Explorer 3.0

See Also

HLNF, HlinkNavigateMoniker, HlinkNavigateToStringReference, IHlink::Navigate