HlinkNavigateString

This function executes a hyperlink jump to a new document or object (specified in szTarget). HlinkNavigateString is implemented as a simple macro that calls the HlinkSimpleNavigateToString function, passing it NULL for most parameters.

HRESULT HlinkNavigateString(
  IUnknown * pUnk,  //IUnknown pointer to the initiating document or 
                    // object
  LPCWSTR szTarget  //Moniker of the hyperlink target
);
 

Parameters

pUnk

[in] Pointer to the IUnknown interface on the document or object that is initiating the hyperlink. If NULL, it is assumed the hyperlink originates from an ActiveX-unaware application.

szTarget

[in] String which helps identify the hyperlink target. This string is resolved into a moniker for underlying binding operations via MkParseDisplayNameEx. If NULL, then the navigation is within a document.

Return Values

S_OK

A hyperlink jump to a new document or object has executed successfully.

Remarks

The HlinkNavigateString helper function should be used by all applications, documents, and objects that have simple navigation needs. This single function call that will "do the right thing" depending on whether the navigation is originating from within a hyperlink frame or within a hyperlink-unaware application.

QuickInfo

  Windows NT: Use version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in hlink.h.

See Also

HLNF, HlinkNavigateMoniker, HlinkNavigateToStringReference, HlinkSimpleNavigateToString, IHlink::Navigate