IConsoleTab.GetHelp Method

Indicates how to display Help content for your custom Console tab.

Namespace: Microsoft.HomeServer.Extensibility
Assembly: HomeServerExt (in homeserverext.dll)

Usage

Syntax

'Declaration
Function GetHelp As Boolean

bool GetHelp ()

bool GetHelp ()

boolean GetHelp ()

function GetHelp () : boolean

Return Value

A boolean value that is reserved for future use. Display your custom Help and return true.

Remarks

To provide custom Help for your Console tab, use this method to implement how your Help content is displayed, and then return true.

The Windows Home Server Console calls GetHelp from a tab page or settings page when the page is displayed and the user clicks Help or presses F1. To provide custom Help for your tab, display your Help synchronously on the same thread when GetHelp is called. You must provide your own code to display your Help. Common Help mechanisms include a compiled help (.CHM) file or HTML page. After you display your custom Help, return true.

Additionally, because the Windows Home Server Console is primarily run on a home computer through the Windows Home Server Connector, your Help content should be implemented so that it can be displayed on a home computer. If necessary, this may require that your Help content is installed on home computers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Vista, Windows Server 2003, Windows XP

Target Platforms

Windows Home Server

See Also

Reference

IConsoleTab Interface
IConsoleTab Members
Microsoft.HomeServer.Extensibility Namespace