Contents Previous Page Next Page
HlinkNavigateToStringReference

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.

HlinkNavigateToStringReference(

    LPCWSTR 
szTarget,                   //String helping to identify the hyperlink target             
                                                                                                      
    LPCWSTR szLocation,                 //Location within the hyperlink target of new hyperlink       
                                                                                                      
    IHlinkSite * phlSite,               //Site object interface for the new hyperlink object          
                                                                                                      
    DWORD dwSiteData,                   //Additional site data for the new hyperlink object           
                                                                                                      
    IHlinkFrame * phlFrame,             //Frame object interface for the new hyperlink object         
                                                                                                      
    DWORD grfHLNF,                      //Navigation flags                                            
                                                                                                      
    IBindCtx * pbc,                     //Bind context object                                         
                                                                                                      
    IBindStatusCallback * pbsc,         //Bind status callback object                                 
                                                                                                      
    IHlinkBrowseContext * phlbc         //Browse context object                                       
                                                                                                      
   );                                                                                                 
                                                                                                      

Parameters

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.

phlSite

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

dwSiteData

[in] Additional site data for the new hyperlink object

phlFrame

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

grfHLNF

[in] Value taken from the HLNF enumeration.

pbc

[in] IBindCtx interface pointer to the bind context object to use for any moniker binding performed during the navigation. May not be NULL.

pbsc

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

phlbc

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

Return Values

S_OK

A hyperlink site was created and navigated to.

Remarks

This helper API is identical to calling:

// create hyperlink site, IBindStatusCallback,

// gather bind context, and browse context

HlinkCreateFromString(szTarget, szLocation,

szFriendlyName, &hlSite, dwSiteData, NULL,

IID_IHlink, (void**)&phl);

HlinkNavigate(phl, phlFrame, grfHLNF, pbc, pbsc, phlbc);

phl->Release();

See Also

HLNF, HlinkNavigate, HlinkCreateFromString, HlinkSimpleNavigateToString