HlinkOnNavigate

HlinkOnNavigate

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

HlinkOnNavigate(

    IHlinkFrame

 * phlFrame,              //Frame object interface for the new hyperlink

    IHlinkBrowseContext * phlbc,         //Browse context object to use for this navigation

    DWORD grfHLNF,                       //Navigation flags

    LPCWSTR szTarget,                    //String helping to identify the hyperlink target

    LPCWSTR szLocation,                  //Location within the hyperlink target of new hyperlink

    LPCWSTR szFriendlyName               //Friendly name of the hyperlink

);

Parameters

phlFrame

[in] Pointer to the IHlinkFrame interface of the hyperlink container. May be NULL if the hyperlink container does not have a hyperlink frame.

phlbc

[in] Pointer to 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.

szTarget

[in] String which helps identify the hyperlink target. This string is resolved into a moniker for underlying binding operations via MkParseDisplayNameEx. May not be NULL.

szLocation

[in] Location within the hyperlink target of new hyperlink object.

szFriendlyName

[in] The friendly name of the hyperlink.

Return Values

S_OK

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

Remarks

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

phlbc->OnNavigateHlink(grfHLNF, pmkTarget, szLocation, szFriendlyName);

if (phlframe)

    phlframe->OnNavigate(grfHLNF);