HelpAndSupport

  • Article

Important

In Windows 10, the HelpAndSupport settings are deprecated because the Help component that they impact is being retired. Existing information about the HelpAndSupport settings are provided for reference only. Windows 10 offers a new user support system, the Get Help app. For more information, see Customize the Get Help app.

In Windows 10, the OS disables the help components that shipped in Windows 8 and Windows 8.1 including the Help and Support Windows desktop application (HelpPane.exe). HelpPane.exe will continue to exist in the box, but calls to its interfaces will result in one of two outcomes:

  • If the user is offline, the OS launches the Getting Started app.
  • If the user is online, the OS opens a browser instance and redirects the browser to an online topic.

For more information on how OEMs can include their customer support contact information in the Contact Support App or Support Web page, see OEMInformation.

Child Elements

Logo

Specifies the path of an image file that contains the logo of the OEM or organization.

LogoURL

Specifies the URL for a support page for the OEM or organization.

Manufacturer

Specifies the name of the OEM.

SearchContent

Specifies whether the OEM or organization has provided offline Help content that the system must return in the search results.

SupportSearchURL

Specifies the URL that the system uses to display a search link on the page of search results.

TileColor

Specifies the RGB background color of the tile for the OEM or organization on the Help and Support home page.

Valid Configuration Passes

oobeSystem

specialize

Parent Hierarchy

Microsoft-Windows-HelpAndSupport | HelpAndSupport

XML Example

The following example shows how to set values for customizing the Help and Support user interface. This example customizes the Help and Support page to have a blue (16711680) OEM tile that includes the Fabrikam logo. When a user clicks the tile, the default Web browser opens https://www.fabrikam.com/support. When a user performs a search while offline, the system returns the matching offline Fabrikam topics in the Help and Support search results. When a user performs a search while online, the system returns the matching Fabrikam topics from the https://www.fabrikam.com/support/search page in the Help and Support search results. The Fabrikam name appears on the search-results page and on the OEM tile on the home page.

<HelpAndSupport>
  <Logo>C:\Fabrikam\Logos\Logo.bmp</Logo>
  <LogoURL>https://www.fabrikam.com/support</LogoURL>
  <Manufacturer>Fabrikam</Manufacturer>
  <SearchContent>true</SearchContent>
  <SupportSearchURL>https://www.fabrikam.com/support/search/?term={Query}</SupportSearchURL>
  <TileColor>16711680</TileColor>
</HelpAndSupport>

Components

OEMInformation