HlinkSimpleNavigateToString Function

---

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

Syntax

HRESULT HlinkSimpleNavigateToString(
    LPCWSTR szTarget,    
    LPCWSTR szLocation,   
    LPCWSTR szTargetFrameName,    
    IUnknown *pUnk,     
    IBindCtx *pbc,      
    IBindStatusCallback *pbsc,   
    DWORD grfHLNF,      
    DWORD dwReserved     
);

Parameters

szTarget

[in] String that helps identify 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. This parameter is required.

szLocation

[in] Optional. String that specifies the location within the hyperlink target for the new hyperlink.

szTargetFrameName

[in] Optional. String that specifies the name of the target frame for the hyperlink navigation. This argument only affects navigation within a document container that supports framesets.

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. Note that if the caller of this function is an ActiveX control or document object, you must pass a valid value for this parameter for navigation to succeed.

pbc

[in] Address of the IBindCtx interface on the bind context to use for any moniker binding performed during the navigation. This must not be NULL.

pbsc

[in] Address of the IBindStatusCallback interface on the bind-status-callback to use for any asynchronous moniker binding performed during the navigation. The bind-status-callback will only return the standard IUnknown methods: AddRef and QueryInterface. When navigating in a new window, the only IBindStatusCallback method that gets called is GetBindInfo. If this is NULL, the caller does not receive progress notification, cancellation, pausing, or low-level binding information.

grfHLNF

[in] Unsigned long integer value that specifies one of the HLNF values.

dwReserved

[in] Reserved for future use; must be set to NULL.

Return Value

Returns S_OK if successful, or an error code otherwise.

Remarks

This function is called by HlinkNavigateString. The HlinkSimpleNavigateToString 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

HlinkNavigateToStringReference, HlinkSimpleNavigateToMoniker, IHlink::Navigate