msIsSiteModeFirstRun method

  • Article

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

This method is not supported for Windows apps using JavaScript.

 

Syntax

 retVal = object.msIsSiteModeFirstRun(fPreserveState);

Parameters

fPreserveState [in]

Type: VARIANT_BOOL

VARIANT_FALSE (false)

Read and clear the first-run state.

VARIANT_TRUE (true)

Only read the state, do not clear it.

Standards information

There are no standards that apply here.

Remarks

The IShellUIHelper4::msIsSiteModeFirstRun method detects whether the current pinned site window is in a first-run state, right after installation. This method returns SITEMODE_NOTFIRSTRUN 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 VARIANT_TRUE, the IShellUIHelper4::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.

See also

Reference

IShellUIHelper4::msAddSiteMode

IShellUIHelper4::msIsSiteMode