Share via

ReadyToNavigate method

  • Article

[IHlinkSite::ReadyToNavigate may be altered or unavailable in subsequent versions of the operating system or product.]

Note  The Microsoft ActiveX Hyperlink API is deprecated in Windows Internet Explorer 8 and later, and ActiveX technology as a whole is unsupported in the Microsoft Edge browser in favor of standards-based web APIs. For more information, see Saying goodbye to ActiveX, VBScript, attachEvent... and Get ready for plug-in free browsing.

 

Notifies the hyperlink site that the hyperlink navigation is about to occur.

Syntax

HRESULT retVal = object.ReadyToNavigate(dwSiteData, dwReserved);

Parameters

  • dwSiteData [in]
    Type: DWORD

    An unsigned long integer value that specifies the hyperlink to the hyperlink site. The hyperlink site initializes the hyperlink with this value as part of IHlink::SetHlinkSite.

  • dwReserved [in]
    Type: DWORD

    Reserved. Must be set to 0.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

If this method returns E_ABORT, cancel the operation.

See also

Reference

HlinkOnNavigate

IHlinkBrowseContext::OnNavigateHlink

IHlinkFrame::OnNavigate