msIsSiteMode method

  • Article

Determines whether the current page was launched as a pinned site.

This method is not supported for Windows apps using JavaScript.

 

Syntax

HRESULT retVal = object.msIsSiteMode(pfSiteMode);

Parameters

  • pfSiteMode [out, retval]
    Type: VARIANT_BOOL

    A VARIANT_BOOL value that receives VARIANT_TRUE if the current page was launched as a pinned site; VARIANT_FALSE otherwise.

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

You can use this method to configure your webpages differently if they are running as a pinned site versus the normal browser mode.

Only pages within the same domain as the pinned site start URL are considered to be part of the pinned site. If a page from a different domain is opened inside the pinned site window, then IShellUIHelper4::msIsSiteMode returns VARIANT_FALSE.

To pin a site, Windows Internet Explorer requires Windows 7 or later.

See also

IShellUIHelper4::msAddSiteMode