HlinkOnNavigate Function

---

Notifies a hyperlink browse context and hyperlink frame, if it exists, that a hyperlink target has been navigated to.

Syntax

HRESULT HlinkOnNavigate(
    IHlinkFrame *pihlframe,    
    IHlinkBrowseContext *pihlbc,   
    DWORD grfHLNF,      
    IMoniker *pimkTarget,      
    LPCWSTR pwzLocation,        
    LPCWSTR pwzFriendlyName,    
    ULONG *puHLID      
);

Parameters

pihlframe

[in] Address of the IHlinkFrame interface of the hyperlink container. This can be NULL if the hyperlink container does not have a hyperlink frame.

pihlbc

[in] Address of the IHlinkBrowseContext interface for the browse context object to use for this navigation. The browse context includes history information, where this navigation is logged if grfHLNF is not set to HLNF_CREATENOHISTORY.

grfHLNF

[in] Value taken from the HLNF enumeration.

pimkTarget

[in, unique] Address of an IMoniker interface on the hyperlink target.

pwzLocation

[in] Address of the location within the hyperlink target of the new hyperlink object.

pwzFriendlyName

[in] Address of the friendly name of the hyperlink.

puHLID

[out] Address of the hyperlink identifier to set in the current browse context's navigation stack.

Return Value

Returns S_OK if successful.

Example

HlinkOnNavigate is a helper function typically called during IHlinkTarget::Navigate, which encapsulates the following calls:

phlbc->OnNavigateHlink(grfHLNF, pimkTarget, pwzLocation, pwzFriendlyName);
if (phlFrame)
    phlFrame->OnNavigate(grfHLNF);

Function Information

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

See Also

IHlinkBrowseContext::OnNavigateHlink, IHlinkFrame::OnNavigate, IHlinkSite::OnNavigationComplete