LoadHistoryPosition method

  • Article

Scrolls document to the local anchor position.

Syntax

HRESULT retVal = object.LoadHistoryPosition(pszUrlLocation, dwPosition);

Parameters

  • pszUrlLocation [in]
    Type: LPWSTR

    A string that specifies the URL fragment (local anchor).

  • dwPosition [in]
    Type: DWORD

    A DWORD that specifies the vertical scroll position of the anchor. Can be set to 0.

Return value

Type: HRESULT

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

Remarks

LoadHistoryPosition was introduced in Windows Internet Explorer 7.

This method is used during a history navigation in a frame that specifies a URL fragment (local anchor). Invoking this method fires the DWebBrowserEvents2::BeforeNavigate2 event, which can be canceled. If the navigation is successful, the existing travel log entry is updated with the new URL fragment.