replace method

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

This method is not supported for Windows Store apps built for Windows using JavaScript.

Syntax

HRESULT retVal = object.replace(bstr);

Parameters

bstr [in]

Type: BSTR

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

Return value

Type: HRESULT

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

Standards information

There are no standards that apply here.

Remarks

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: 11/12/2012