msIsSiteModeFirstRun Method

Determines whether a pinned site was launched for the first time.

Syntax

Copy

uiFirstRun = window.external.msIsSiteModeFirstRun(fPreserveState)

Parameters

fPreserveState

One of the following required values: false Read and clear the first-run state. true Only read the state, do not clear it.

Return Value

Returns one of the following values:

0

The pinned site is not in a first-run state.

1

First run from a drag and drop operation.

2

First run from a shortcut added to the Start menu. See msAddSiteMode.

Possible Exceptions

Not implemented (0x80004001)

This method is not supported on Windows CE.

Remarks

The msIsSiteModeFirstRun method detects whether the current pinned site window is in a first-run state, right after installation. This method returns 0 for any page that is not in the same domain as the start URL, or if the current pinned site window is not the one that appeared immediately after installation.

If fPreserveState is true, the msIsSiteModeFirstRun method does not reset the first-run state, and instead returns the same value for any page visited (even those shown in new tabs and new windows) during the first run, provided that the page is from the same domain as the start URL.

Applies To

external

See Also

msAddSiteMode, msIsSiteMode