Share via

replace method

[This documentation is preliminary and is subject to change.]

Replaces the current document by loading another document at the specified URL.

This method is not supported for Metro style apps using JavaScript.


HRESULT retVal = object.replace(bstr);

Standards information

There are no standards that apply here.


  • bstr [in]
    Type: BSTR

    BSTR that specifies the URL to insert into the session history.

Return value


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


When a document is replaced, it is also removed from the history object. Moreover, the user interface navigation methods, such as the Back and Forward buttons, will no longer access the URL.



Build date: 6/12/2012