IConsoleServices.OpenHelp Method (Microsoft.HomeServer.Extensibility)

OpenHelp Method

Switch on low bandwidth view

Collapse All

Language Filter

IConsoleServices.OpenHelp Method

Opens the specified Help content file.

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

Usage

Syntax

Visual Basic

Sub OpenHelp ( _
    fileName As String, _
    guidTopic As String _
)

void OpenHelp (
    string fileName,
    string guidTopic
)

C++

void OpenHelp (
    String^ fileName, 
    String^ guidTopic
)

void OpenHelp (
    String fileName, 
    String guidTopic
)

JScript

function OpenHelp (
    fileName : String, 
    guidTopic : String
)

Parameters

fileName: A string that represents the path of the compiled Help file (.chm), relative to the Windows Home Server program files directory.

guidTopic: A string that contains the GUID for a specific Help topic.

Remarks

If you do not provide a GUID, the Help topic is not displayed. To find the GUID for a Help topic in the Help file, right-click the page, and then click Properties. The GUID is at the end of the Address for the page with an .htm extension.

Because the Windows Home Server Console is primarily run on a Windows Home Server home computer through the Windows Home Server Connector, the specified Help file must be installed on home computers as well as on the home server. The installation location on the home computer is %ProgramFiles%\Windows Home Server.

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

Reference

IConsoleServices Interface
IConsoleServices Members
Microsoft.HomeServer.Extensibility Namespace