HlinkNavigateToStringReference Function

---

Creates a hyperlink site from strings representing the hyperlink target, the location within the target, and a friendly name, and then navigates to that site.

Syntax

HRESULT HlinkNavigateToStringReference(
    LPCWSTR pwzTarget,        
    LPCWSTR pwzLocation,      
    IHlinkSite *pihlsite,    
    DWORD dwSiteData,         
    IHlinkFrame *pihlframe,  
    DWORD grfHLNF,    
    LPBC pibc,        
    IBindStatusCallback *pibsc,    
    IHlinkBrowseContext *pihlbc    
);

Parameters

pwzTarget

[in] Address of the string that helps identify the hyperlink target. This string is resolved into a moniker for underlying binding operations through MkParseDisplayNameEx. This must not be NULL.

pwzLocation

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

pihlsite

[in] Address of the IHlinkSite interface on the site object for the new hyperlink object. This is optional, in which case pwzTarget must be an absolute reference.

dwSiteData

[in] Additional site data for the new hyperlink object.

pihlframe

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

grfHLNF

[in] Value taken from the HLNF enumeration.

pibc

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

pibsc

[in] Address of the IBindStatusCallback interface on the bind-status-callback object to use for any asynchronous moniker binding performed during the navigation. This can be NULL, in which case the caller is not interested in progress notification, cancellation, pausing, or low-level binding information.

pihlbc

[in] IHlinkBrowseContext interface pointer to 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.

Return Value

Returns S_OK if successful.

Example

This helper function is identical to calling the following:

// create hyperlink site, IBindStatusCallback,
// gather bind context, and browse context 
HlinkCreateFromString(pwzTarget, pwzLocation,
    pwzFriendlyName, &hlSite, dwSiteData, NULL,
    IID_IHlink, (void**)&phl);
HlinkNavigate(pihl, pihlframe, grfHLNF, pbc, pibsc, pihlbc);
phl->Release();

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

HLNF, HlinkNavigate, HlinkCreateFromString, HlinkSimpleNavigateToString