Contents Index Topic Contents
	Previous Topic: HlinkNavigateToStringReference Next Topic: HlinkQueryCreateFromData

HlinkOnNavigate

HRESULT HlinkOnNavigate(
    IHlinkFrame * pihlframe,    //Frame object interface for the new hyperlink
    IHlinkBrowseContext * pihlbc,    //Browse context object to use for this navigation
    DWORD grfHLNF,      //Navigation flags
    IMoniker * pimkTarget,      //Moniker interface pointer of the hyperlink target
    LPCWSTR pwzLocation,        //Location within the hyperlink target of new hyperlink
    LPCWSTR pwzFriendlyName,    //Friendly name of the hyperlink
    ULONG * puHLID      // Pointer to hyperlink identifier
   );

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

• Returns S_OK if the browse context and the frame, if it exists, have been notified of the hyperlink navigation.

pihlframe

[in] Address of the IHlinkFrame interface of the hyperlink container. 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 in which this navigation is logged, if !(grfHLNF & 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.

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);

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

---

 Top of Page
© 1997 Microsoft Corporation. All rights reserved. Terms of Use.